mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-01 17:36:35 +00:00
8d33a3de0d
* Made method descriptions imperative: "Do this" rather than "Does this" * Changed use of "this object" to "the object" in method documentation * Added missing documentation * Fixed incorrect documentation * Fixed incorrect debug method names (as in those VeDmClassName tags we add to functions so they make sense when dumped into in the console) * Normalized use of package names throughout * Normalized class descriptions * Removed incorrect @abstract tags * Added missing @method tags * Lots of other minor cleanup Change-Id: I4ea66a2dd107613e2ea3a5f56ff54d675d72957e
70 lines
1.4 KiB
JavaScript
70 lines
1.4 KiB
JavaScript
/*!
|
|
* VisualEditor ContentAction class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Content action.
|
|
*
|
|
* @class
|
|
* @extends ve.Action
|
|
* @constructor
|
|
* @param {ve.Surface} surface Surface to act on
|
|
*/
|
|
ve.ContentAction = function VeContentAction( surface ) {
|
|
// Parent constructor
|
|
ve.Action.call( this, surface );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ContentAction, ve.Action );
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* List of allowed methods for the action.
|
|
*
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.ContentAction.static.methods = ['insert', 'remove', 'select'];
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Insert content.
|
|
*
|
|
* @method
|
|
* @param {string|Array} content Content to insert, can be either a string or array of data
|
|
* @param {boolean} annotate Content should be automatically annotated to match surrounding content
|
|
*/
|
|
ve.ContentAction.prototype.insert = function ( content, annotate ) {
|
|
this.surface.getModel().getFragment().insertContent( content, annotate );
|
|
};
|
|
|
|
/**
|
|
* Remove content.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ContentAction.prototype.remove = function () {
|
|
this.surface.getModel().getFragment().removeContent();
|
|
};
|
|
|
|
/**
|
|
* Select content.
|
|
*
|
|
* @method
|
|
* @param {ve.Range} range Range to select
|
|
*/
|
|
ve.ContentAction.prototype.select = function ( range ) {
|
|
this.surface.getModel().change( null, range );
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.actionFactory.register( 'content', ve.ContentAction );
|