mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.AnnotationButtonTool.js
Timo Tijhof ab7d6bf082 Documentation & clean up
* Commands for Sublime:

  Find*: "(\* @[a-z]+) ([^{].*) \{(.*)\}"
  Replace: "$1 {$3} $2"

  Save all && Close all

  Find: " function("
  Replace: " function ("

  Save all && Close all

  Find: "Intialization"
  Replace: "Initialization"

  Save all && Close all

* Consistent use of types (documented in CODING.rm):
  - Merged {Integer} into {Number}.
  - Merged {DOM Node} into {DOMElement}.

* Remove work-around /*jshint newcap: false */ from ve.js
  Calling Object() as a function to to use the internal
  toObject no longer throws a newcap warning in JSHint.
  It only does that normal functions now .

  (e.g. var a = Cap(); or var a = new uncap();)

* Add missing annotations (@static, @method, ..).

* Remove unused variables

* Remove null-assignments to variables that should just be
  undefined. There's a few variables explicitly set to null
  whereas they are set a few lines under and not used otherwise
  (e.g. 'tx' in ve.ce.Surface.prototype.onPaste)

Change-Id: I0721a08f8ecd93c25595aedaa1aadb0e08b83799
2012-09-17 16:02:52 +02:00

87 lines
2.2 KiB
JavaScript

/**
* VisualEditor user interface AnnotationButtonTool class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.AnnotationButtonTool object.
*
* @class
* @constructor
* @extends {ve.ui.ButtonTool}
* @param {ve.ui.Toolbar} toolbar
* @param {String} name
* @param title
* @param {Object} data
*/
ve.ui.AnnotationButtonTool = function VeUiAnnotationButtonTool( toolbar, name, title, data ) {
// Parent constructor
ve.ui.ButtonTool.call( this, toolbar, name, title );
// Properties
this.annotation = data.annotation;
this.inspector = data.inspector;
this.active = false;
};
/* Inheritance */
ve.inheritClass( ve.ui.AnnotationButtonTool, ve.ui.ButtonTool );
/* Methods */
ve.ui.AnnotationButtonTool.prototype.onClick = function () {
var surfaceView = this.toolbar.getSurfaceView(),
surfaceModel = surfaceView.model,
selection = surfaceModel.getSelection();
if ( this.inspector ) {
if ( selection && selection.getLength() ) {
surfaceView.contextView.openInspector( this.inspector );
}
} else {
surfaceModel.annotate( this.active ? 'clear' : 'set', this.annotation );
}
};
ve.ui.AnnotationButtonTool.prototype.updateState = function ( annotations ) {
if ( annotations.hasAnnotationOfType( this.annotation.type ) ) {
this.$.addClass( 've-ui-toolbarButtonTool-down' );
this.active = true;
} else {
this.$.removeClass( 've-ui-toolbarButtonTool-down' );
this.active = false;
}
};
/* Registration */
ve.ui.Tool.tools.bold = {
'constructor': ve.ui.AnnotationButtonTool,
'name': 'bold',
'title': ve.msg( 'visualeditor-annotationbutton-bold-tooltip' ),
'data': {
'annotation': { 'type': 'textStyle/bold' }
}
};
ve.ui.Tool.tools.italic = {
'constructor': ve.ui.AnnotationButtonTool,
'name': 'italic',
'title': ve.msg( 'visualeditor-annotationbutton-italic-tooltip' ),
'data': {
'annotation': { 'type': 'textStyle/italic' }
}
};
ve.ui.Tool.tools.link = {
'constructor': ve.ui.AnnotationButtonTool,
'name': 'link',
'title': ve.msg( 'visualeditor-annotationbutton-link-tooltip' ),
'data': {
'annotation': { 'type': 'link/WikiLink', 'data': { 'title': '' } },
'inspector': 'link'
}
};