/*!
* VisualEditor ContentEditable MWReferenceListNode class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* ContentEditable MediaWiki reference list node.
*
* @class
* @extends ve.ce.LeafNode
* @mixins ve.ce.ProtectedNode
*
* @constructor
* @param {ve.dm.MWReferenceListNode} model Model to observe
* @param {Object} [config] Config options
*/
ve.ce.MWReferenceListNode = function VeCeMWReferenceListNode( model, config ) {
// Parent constructor
ve.ce.LeafNode.call( this, model, config );
// Mixin constructors
ve.ce.ProtectedNode.call( this );
ve.ce.FocusableNode.call( this );
// DOM Changes
this.$.addClass( 've-ce-mwReferenceListNode', 'reference' )
.attr( 'contenteditable', false );
this.$reflist = $( '
' );
this.$.append( this.$reflist );
// Events
this.model.getDocument().internalList.connect( this, { 'update': 'onInternalListUpdate' } );
this.model.getDocument().internalList.getListNode().connect( this, { 'update': 'onListNodeUpdate' } );
// Initialization
this.update();
};
/* Inheritance */
ve.inheritClass( ve.ce.MWReferenceListNode, ve.ce.LeafNode );
ve.mixinClass( ve.ce.MWReferenceListNode, ve.ce.ProtectedNode );
ve.mixinClass( ve.ce.MWReferenceListNode, ve.ce.FocusableNode );
/* Static Properties */
ve.ce.MWReferenceListNode.static.name = 'mwReferenceList';
ve.ce.MWReferenceListNode.static.tagName = 'div';
/* Methods */
/**
* 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.MWReferenceListNode.prototype.onInternalListUpdate = function ( groupsChanged ) {
// Only update if this group has been changed
if ( ve.indexOf( this.model.getAttribute( 'listGroup' ), groupsChanged ) !== -1 ) {
this.update();
}
};
/**
* Handle the updating of the InternalListNode.
*
* This will occur after changes to any InternalItemNode.
*
* @method
*/
ve.ce.MWReferenceListNode.prototype.onListNodeUpdate = function () {
// When the list node updates we're not sure which list group the item
// belonged to so we always update
// TODO: Only re-render the reference which has been edited
this.update();
};
/**
* Update the reference list.
*/
ve.ce.MWReferenceListNode.prototype.update = function () {
var i, j, iLen, jLen, index, firstNode, key, keyedNodes, $li, itemNode,
internalList = this.model.getDocument().internalList,
listGroup = this.model.getAttribute( 'listGroup' ),
nodes = internalList.getNodeGroup( listGroup );
// HACK: detach the children attached in the previous run
while ( this.attachedItems && this.attachedItems.length > 0 ) {
itemNode = this.attachedItems.pop();
itemNode.setLive( false );
itemNode.detach( this );
}
this.attachedItems = this.attachedItems || [];
this.$reflist.empty();
if ( nodes && nodes.indexOrder.length ) {
for ( i = 0, iLen = nodes.indexOrder.length; i < iLen; i++ ) {
index = nodes.indexOrder[i];
firstNode = nodes.firstNodes[index];
$li = $( '- ' );
key = internalList.keys[index];
keyedNodes = nodes.keyedNodes[key] || [];
for ( j = 0, jLen = keyedNodes.length; j < jLen; j++ ) {
if ( keyedNodes.length > 1 ) {
$li.append(
$( '' ).append(
$( '' ).text( ( i + 1 ) + '.' + j )
)
).append( ' ' );
}
}
// Generate reference HTML from first item in key
itemNode = new ve.ce.InternalItemNode(
internalList.getItemNode( firstNode.getAttribute( 'listIndex' ) )
);
// HACK: PHP parser doesn't wrap single lines in a paragraph
if ( itemNode.$.children().length === 1 && itemNode.$.children( 'p' ).length === 1 ) {
// unwrap inner
itemNode.$.children().replaceWith( itemNode.$.children().contents() );
}
// HACK: ProtectedNode crashes when dealing with an unattached node
this.attachedItems.push( itemNode );
itemNode.attach( this );
$li.append( $( '' ).html( itemNode.$.clone().show() ) );
this.$reflist.append( $li );
}
} // TODO: Show a placeholder for an empty reference list in the 'else' section
};
/* Registration */
ve.ce.nodeFactory.register( ve.ce.MWReferenceListNode );