mediawiki-extensions-Visual.../modules/ve-mw/ce/nodes/ve.ce.MWMathNode.js
Timo Tijhof 8f05cdbf70 doc: Add placeholders for unindexed methods
Not having a description yet is fine, but they should at least
be indexed as blocks so that they are searchable and listed
in the jsduck generated pages. jsduck defaults to @method + name
of prototype property. And it even guesses parameters sometimes.

Search: \n\n([a-zA-Z\.]+\.prototype\.[a-zA-Z]+)
Where: modules/ve,modules/ve-mw
Where-Not: modules/ve/test
Replace: \n\n/** */\n$1

Added @return in a few places where it was easy to add.

Change-Id: I830c94cc7dbc261bd7a077391f930cbfff165f9d
2013-07-31 23:00:30 +00:00

143 lines
3.7 KiB
JavaScript

/*!
* VisualEditor ContentEditable MWMathNode class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/*global mw, MathJax */
/**
* ContentEditable MediaWiki math node.
*
* @class
* @extends ve.ce.LeafNode
* @mixins ve.ce.FocusableNode
* @mixins ve.ce.ProtectedNode
* @mixins ve.ce.GeneratedContentNode
*
* @constructor
* @param {ve.dm.MWMathNode} model Model to observe
* @param {Object} [config] Config options
*/
ve.ce.MWMathNode = function VeCeMWMathNode( model, config ) {
var $wrapper;
// Parent constructor
ve.ce.LeafNode.call( this, model, config );
// Wrap image
this.$image = this.$;
$wrapper = $( '<span> ');
this.$.wrap( $wrapper );
this.$ = $wrapper;
// Mixin constructors
ve.ce.FocusableNode.call( this );
ve.ce.ProtectedNode.call( this );
ve.ce.GeneratedContentNode.call( this );
// Events
this.model.connect( this, { 'update': 'onUpdate' } );
this.$.on( 'click', ve.bind( this.onClick, this ) );
// DOM Changes
this.$.addClass( 've-ce-mwMathNode' );
};
/* Inheritance */
ve.inheritClass( ve.ce.MWMathNode, ve.ce.LeafNode );
ve.mixinClass( ve.ce.MWMathNode, ve.ce.FocusableNode );
ve.mixinClass( ve.ce.MWMathNode, ve.ce.ProtectedNode );
ve.mixinClass( ve.ce.MWMathNode, ve.ce.GeneratedContentNode );
/* Static Properties */
ve.ce.MWMathNode.static.name = 'mwMath';
ve.ce.MWMathNode.static.tagName = 'img';
/* Methods */
/** */
ve.ce.MWMathNode.prototype.generateContents = function () {
var deferred = $.Deferred();
$.ajax( {
'url': mw.util.wikiScript( 'api' ),
'data': {
'action': 'visualeditor',
'paction': 'parsefragment',
'page': mw.config.get( 'wgRelevantPageName' ),
'wikitext': '<math>' + this.getModel().getAttribute( 'mw' ).body.extsrc + '</math>',
'token': mw.user.tokens.get( 'editToken' ),
'format': 'json'
},
'dataType': 'json',
'type': 'POST',
// Wait up to 100 seconds before giving up
'timeout': 100000,
'cache': 'false',
'success': ve.bind( this.onParseSuccess, this, deferred ),
'error': ve.bind( this.onParseError, this, deferred )
} );
return deferred.promise();
};
/**
* Handle a successful response from the parser for the wikitext fragment.
*
* @param {jQuery.Deferred} deferred The Deferred object created by generateContents
* @param {Object} response Response data
*/
ve.ce.MWMathNode.prototype.onParseSuccess = function ( deferred, response ) {
var data = response.visualeditor, contentNodes = $( data.content ).get();
// HACK: unwrap paragraph from PHP parser
contentNodes = Array.prototype.slice.apply( contentNodes[0].childNodes );
deferred.resolve( contentNodes );
if ( $( contentNodes ).is( 'span.tex' ) ) {
// MathJax
MathJax.Hub.Queue( [ 'Typeset', MathJax.Hub ] );
} else {
// Rerender after image load
this.$.find( 'img' ).on( 'load', ve.bind( function () {
this.emit( 'rerender' );
}, this ) );
}
};
/**
* Handle an unsuccessful response from the parser for the wikitext fragment.
*
* @param {jQuery.Deferred} deferred The promise object created by generateContents
* @param {Object} response Response data
*/
ve.ce.MWMathNode.prototype.onParseError = function ( deferred ) {
deferred.reject();
};
/**
* Handle the mouse click.
*
* @method
* @param {jQuery.Event} e Click event
*/
ve.ce.MWMathNode.prototype.onClick = function ( e ) {
var surfaceModel = this.getRoot().getSurface().getModel(),
selectionRange = surfaceModel.getSelection(),
nodeRange = this.model.getOuterRange();
surfaceModel.getFragment(
e.shiftKey ?
ve.Range.newCoveringRange(
[ selectionRange, nodeRange ], selectionRange.from > nodeRange.from
) :
nodeRange
).select();
};
/* Registration */
ve.ce.nodeFactory.register( ve.ce.MWMathNode );