mediawiki-extensions-Visual.../modules/ve/ui/actions/ve.ui.AnnotationAction.js
Trevor Parscal 3e460a02df Cleanup action methods
Changes:
* Remove reference to inspector close method, which didn't actually exist
* Use more spacy array syntax for all action methods

Change-Id: I08ee2d262acc7b39456766fb4a0b490da88ad041
2013-09-11 10:25:46 -07:00

113 lines
3 KiB
JavaScript

/*!
* VisualEditor UserInterface AnnotationAction class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Annotation action.
*
* @class
* @extends ve.ui.Action
* @constructor
* @param {ve.ui.Surface} surface Surface to act on
*/
ve.ui.AnnotationAction = function VeUiAnnotationAction( surface ) {
// Parent constructor
ve.ui.Action.call( this, surface );
};
/* Inheritance */
ve.inheritClass( ve.ui.AnnotationAction, ve.ui.Action );
/* Static Properties */
/**
* List of allowed methods for the action.
*
* @static
* @property
*/
ve.ui.AnnotationAction.static.methods = [ 'set', 'clear', 'toggle', 'clearAll' ];
/* Methods */
/**
* Set an annotation.
*
* @method
* @param {string} name Annotation name, for example: 'textStyle/bold'
* @param {Object} [data] Additional annotation data
*/
ve.ui.AnnotationAction.prototype.set = function ( name, data ) {
this.surface.getModel().getFragment().annotateContent( 'set', name, data );
};
/**
* Clear an annotation.
*
* @method
* @param {string} name Annotation name, for example: 'textStyle/bold'
* @param {Object} [data] Additional annotation data
*/
ve.ui.AnnotationAction.prototype.clear = function ( name, data ) {
this.surface.getModel().getFragment().annotateContent( 'clear', name, data );
};
/**
* Toggle an annotation.
*
* If the selected text is completely covered with the annotation already the annotation will be
* cleared. Otherwise the annotation will be set.
*
* @method
* @param {string} name Annotation name, for example: 'textStyle/bold'
* @param {Object} [data] Additional annotation data
*/
ve.ui.AnnotationAction.prototype.toggle = function ( name, data ) {
var existingAnnotations,
surfaceModel = this.surface.getModel(),
fragment = surfaceModel.getFragment(),
annotation = ve.dm.annotationFactory.create( name, data );
if ( !fragment.getRange().isCollapsed() ) {
fragment.annotateContent(
fragment.getAnnotations().containsComparable( annotation ) ? 'clear' : 'set', name, data
);
} else {
existingAnnotations = surfaceModel
.getInsertionAnnotations().getAnnotationsByName( annotation.name );
if ( existingAnnotations.isEmpty() ) {
surfaceModel.addInsertionAnnotations( annotation );
} else {
surfaceModel.removeInsertionAnnotations( existingAnnotations );
}
}
};
/**
* Clear all annotations.
*
* @method
*/
ve.ui.AnnotationAction.prototype.clearAll = function () {
var i, len, arr,
surfaceModel = this.surface.getModel(),
fragment = surfaceModel.getFragment(),
annotations = fragment.getAnnotations( true );
arr = annotations.get();
// TODO: Allow multiple annotations to be set or cleared by ve.dm.SurfaceFragment, probably
// using an annotation set and ideally building a single transaction
for ( i = 0, len = arr.length; i < len; i++ ) {
fragment.annotateContent( 'clear', arr[i].name, arr[i].data );
}
surfaceModel.setInsertionAnnotations( null );
};
/* Registration */
ve.ui.actionFactory.register( 'annotation', ve.ui.AnnotationAction );