mediawiki-extensions-Visual.../modules/ve/ui/tools/ve.ui.InspectorTool.js
Trevor Parscal d2dfb9ac4f Split oojs-ui from ve.ui
* Move and rename generic parts of ve.ui to OO.ui
* We now have a UI test suite because ve.Element (outside ve.ui)
  is now part of oojs-ui, so it needs a test suite.
* Added to the MW test run (just like we do for unicodejs).
* Updated csslint config (also added ve-mw and syntaxhighlight
  which were missing).

oojs-ui still depends on the TriggerRegistry in VE, this is addressed
in a follow-up commit.

Change-Id: Iec147155c1ddf20b73a4d15d87b8742207032312
2013-10-28 22:40:08 -07:00

102 lines
2.7 KiB
JavaScript

/*!
* VisualEditor UserInterface InspectorTool classes.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* UserInterface inspector tool.
*
* @abstract
* @class
* @extends OO.ui.Tool
* @constructor
* @param {ve.ui.SurfaceToolbar} toolbar
* @param {Object} [config] Configuration options
*/
ve.ui.InspectorTool = function VeUiInspectorTool( toolbar, config ) {
// Parent constructor
OO.ui.Tool.call( this, toolbar, config );
};
/* Inheritance */
OO.inheritClass( ve.ui.InspectorTool, OO.ui.Tool );
/* Static Properties */
/**
* Symbolic name of inspector the tool opens.
*
* @abstract
* @static
* @property {string}
* @inheritable
*/
ve.ui.InspectorTool.static.inspector = '';
/**
* Annotation or node models this tool is related to.
*
* Used by #isCompatibleWith.
*
* @static
* @property {Function[]}
* @inheritable
*/
ve.ui.InspectorTool.static.modelClasses = [];
/**
* @inheritdoc
*/
ve.ui.InspectorTool.static.isCompatibleWith = function ( model ) {
return ve.isInstanceOfAny( model, this.modelClasses );
};
/* Methods */
/**
* Handle the tool being selected.
*
* @method
*/
ve.ui.InspectorTool.prototype.onSelect = function () {
this.toolbar.getSurface().execute( 'inspector', 'open', this.constructor.static.inspector );
this.setActive( false );
};
/**
* Handle the toolbar state being updated.
*
* @method
* @param {ve.dm.Node[]} nodes List of nodes covered by the current selection
* @param {ve.dm.AnnotationSet} full Annotations that cover all of the current selection
* @param {ve.dm.AnnotationSet} partial Annotations that cover some or all of the current selection
*/
ve.ui.InspectorTool.prototype.onUpdateState = function ( nodes, full ) {
var toolFactory = this.toolbar.getToolFactory();
this.setActive( toolFactory.getToolsForAnnotations( full ).indexOf( this.constructor ) !== -1 );
};
/**
* UserInterface link tool.
*
* @class
* @extends ve.ui.InspectorTool
* @constructor
* @param {ve.ui.SurfaceToolbar} toolbar
* @param {Object} [config] Configuration options
*/
ve.ui.LinkInspectorTool = function VeUiLinkInspectorTool( toolbar, config ) {
ve.ui.InspectorTool.call( this, toolbar, config );
};
OO.inheritClass( ve.ui.LinkInspectorTool, ve.ui.InspectorTool );
ve.ui.LinkInspectorTool.static.name = 'link';
ve.ui.LinkInspectorTool.static.group = 'meta';
ve.ui.LinkInspectorTool.static.icon = 'link';
ve.ui.LinkInspectorTool.static.titleMessage = 'visualeditor-annotationbutton-link-tooltip';
ve.ui.LinkInspectorTool.static.inspector = 'link';
ve.ui.LinkInspectorTool.static.modelClasses = [ ve.dm.LinkAnnotation ];
ve.ui.toolFactory.register( ve.ui.LinkInspectorTool );