mediawiki-extensions-Visual.../modules/ve/ce/nodes/ve.ce.MWReferenceNode.js
Trevor Parscal 8039b1c2f8 Insert Reference
Objective:

* Allow opening reference dialog with arbitrary selection
* Auto-insert reference when selection is not a reference node

Changes:

ve.init.mw.ViewPageTarget.js
* Added reference button to toolbar

ve.init.Target.js
* Add getToolbarSubset so we can exclude the reference button from
  the toolbar in the reference dialog (nested references are not
  allowed).

ve.ui.MWReferenceDialog.js
* Stop storing referenceNode (not needed)
* Only store internalItem on open if there's a focused node that's a
  reference
* Use wrapper paragraph when creating a new reference
* Create new reference on dialog close if required

ve.dm.InternalList.js
* Major rewrite to support key less references.
* Add new method for creating a transaction to insert a new iternal
  item. Also returns the index of the new item to be passed to the
  reference node.

Change-Id: I839ae165c299248484ce93d4ab087318a95fbb94
2013-06-10 20:14:08 +01:00

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 listIndex = this.model.getAttribute( 'listIndex' ),
listGroup = this.model.getAttribute( 'listGroup' ),
refGroup = this.model.getAttribute( 'refGroup' ),
position = this.internalList.getIndexPosition( listGroup, listIndex );
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 );