mediawiki-extensions-Visual.../modules/ve/ui/ve.ui.Tool.js

/**
 * VisualEditor user interface Tool class.
 *
 * @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Creates an ve.ui.Tool object.
 *
 * @class
 * @constructor
 * @param {ve.ui.Toolbar} toolbar
 * @param {String} name
 */
ve.ui.Tool = function ( toolbar, name, title ) {
	this.toolbar = toolbar;
	this.name = name;
	this.title = title;
	this.$ = $( '<div class="es-tool"></div>' ).attr( 'title', this.title );
};

/* Static Members */

ve.ui.Tool.tools = {};

/* Methods */

ve.ui.Tool.prototype.updateState = function () {
	throw new Error( 'Tool.updateState not implemented in this subclass:' + this.constructor );
};

ve.ui.Tool.prototype.clearState = function () {
	this.$.removeClass( 'es-toolbarButtonTool-down' );
};
Changed to use MIT license per agreement with the VisualEditor team This license change is aimed at maximizing the reusability of this code in other projects. VisualEditor is more than just an awesome editor for MediaWiki, it's the new editor for the entire internet. Added license and author files, plus mentions of the license to all VisualEditor PHP, JavaScript and CSS files. Parser files have not been modified but are effectively re-licensed since there's no overriding license information. 3rd party libraries are not changed, but are all already MIT licensed. Change-Id: I895b256325db7c8689756edab34523de4418b0f2 2012-07-19 00:11:26 +00:00			`/**`
			`* VisualEditor user interface Tool class.`
Removed some whitespace And added a license to some files that didn't have it yet Change-Id: I3a7e60374d1198d369a0475b8f65f7415012a337 2012-07-19 21:25:16 +00:00			`*`
Changed to use MIT license per agreement with the VisualEditor team This license change is aimed at maximizing the reusability of this code in other projects. VisualEditor is more than just an awesome editor for MediaWiki, it's the new editor for the entire internet. Added license and author files, plus mentions of the license to all VisualEditor PHP, JavaScript and CSS files. Parser files have not been modified but are effectively re-licensed since there's no overriding license information. 3rd party libraries are not changed, but are all already MIT licensed. Change-Id: I895b256325db7c8689756edab34523de4418b0f2 2012-07-19 00:11:26 +00:00			`* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt`
			`* @license The MIT License (MIT); see LICENSE.txt`
			`*/`

Added comments to code 2011-12-05 21:10:19 +00:00			`/**`
Migrated es.* to new ve.* namespace which is more structured, and will make it easier to keep data model, edit surface, user interface and content editable work separated cleanly 2012-02-06 23:50:56 +00:00			`* Creates an ve.ui.Tool object.`
Move ve2/ back to ve/ Change-Id: Ie51d8e48171fb1f84045d1560ee603cee62b91f6 2012-06-20 01:20:28 +00:00			`*`
Added comments to code 2011-12-05 21:10:19 +00:00			`* @class`
			`* @constructor`
Migrated es.* to new ve.* namespace which is more structured, and will make it easier to keep data model, edit surface, user interface and content editable work separated cleanly 2012-02-06 23:50:56 +00:00			`* @param {ve.ui.Toolbar} toolbar`
Added comments to code 2011-12-05 21:10:19 +00:00			`* @param {String} name`
			`*/`
Puttin' em white-spacers where they aught'a be function() -> function () ){ -> ) { Change-Id: I20a85fcf79d7aec64f7f2559e84c0279550d4eea 2012-08-07 01:50:44 +00:00			`ve.ui.Tool = function ( toolbar, name, title ) {`
Set: svn:eol-style => native 2011-12-04 02:59:53 +00:00			`this.toolbar = toolbar;`
			`this.name = name;`
* Added shortcut for links (ctrl/cmd + K) * Added title attributes for tools 2011-12-09 21:16:42 +00:00			`this.title = title;`
			`this.$ = $( '<div class="es-tool"></div>' ).attr( 'title', this.title );`
Set: svn:eol-style => native 2011-12-04 02:59:53 +00:00			`};`

Added comments to code 2011-12-05 21:10:19 +00:00			`/* Static Members */`

Migrated es.* to new ve.* namespace which is more structured, and will make it easier to keep data model, edit surface, user interface and content editable work separated cleanly 2012-02-06 23:50:56 +00:00			`ve.ui.Tool.tools = {};`
Added comments to code 2011-12-05 21:10:19 +00:00
			`/* Methods */`

Puttin' em white-spacers where they aught'a be function() -> function () ){ -> ) { Change-Id: I20a85fcf79d7aec64f7f2559e84c0279550d4eea 2012-08-07 01:50:44 +00:00			`ve.ui.Tool.prototype.updateState = function () {`
After much research on error objects, native = good, custom = bad Stack traces, line numbers, etc. All the approaches I've seen are bad hacks. This is the best way to go. Change-Id: Ib12e9d2ecfe610bcc89d046005e35cc13efa3d99 2012-08-08 17:48:53 +00:00			`throw new Error( 'Tool.updateState not implemented in this subclass:' + this.constructor );`
Set: svn:eol-style => native 2011-12-04 02:59:53 +00:00			`};`
adding clearState function for tools and using clearState if no selection exists Originally committed in SVN as r114418 by Christian, missed the git conversion Change-Id: I56e91c170670519fa2b482a4b7f30cdcbc8ff163 2012-03-22 20:53:26 +00:00
Puttin' em white-spacers where they aught'a be function() -> function () ){ -> ) { Change-Id: I20a85fcf79d7aec64f7f2559e84c0279550d4eea 2012-08-07 01:50:44 +00:00			`ve.ui.Tool.prototype.clearState = function () {`
adding clearState function for tools and using clearState if no selection exists Originally committed in SVN as r114418 by Christian, missed the git conversion Change-Id: I56e91c170670519fa2b482a4b7f30cdcbc8ff163 2012-03-22 20:53:26 +00:00			`this.$.removeClass( 'es-toolbarButtonTool-down' );`
Cleanup of white space, missing semi-colons, line breaks, etc. Change-Id: Ifa96a9f70fa8d149a4c403521aaa88a3e0546ef0 2012-04-02 22:28:26 +00:00			`};`