mediawiki-extensions-Visual.../modules/ve/ui/ve.ui.Inspector.js
Trevor Parscal 6b5310c562 ve.ui.ViewRegistry annihilation
Objectives:
* Associate models with tools, rather than dialogs and inspectors
* Move tool/model association utilities to ve.ui.ToolFactory
* Obliterate the view registry

Notes:

The only special case for leaving modelClasses definitions in place is
for the linkInspector. It uses these for selection expansion.
Because tools can now override the static canEditModel method, we can
dynamically evaluate a model, rather than be restricted to only
comparing classes. This will be useful for disabling editors for models
that are for some reason incomplete or otherwise broken and cannot be
safely edited.

Change-Id: I7adf254990112d90f1f808593a9111afc7a116b5
2013-06-26 16:52:10 -07:00

137 lines
2.9 KiB
JavaScript

/*!
* VisualEditor UserInterface Inspector class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* UserInterface inspector.
*
* @class
* @abstract
* @extends ve.ui.Window
*
* @constructor
* @param {ve.ui.Surface} surface
* @param {Object} [config] Config options
*/
ve.ui.Inspector = function VeUiInspector( surface, config ) {
// Parent constructor
ve.ui.Window.call( this, surface, config );
// Properties
this.initialSelection = null;
// Initialization
this.$.addClass( 've-ui-inspector' );
};
/* Inheritance */
ve.inheritClass( ve.ui.Inspector, ve.ui.Window );
/* Static Properties */
ve.ui.Inspector.static.titleMessage = 've-ui-inspector-title';
/* Methods */
/**
* Handle frame ready events.
*
* @method
*/
ve.ui.Inspector.prototype.initialize = function () {
// Parent method
ve.ui.Window.prototype.initialize.call( this );
// Initialization
this.$form = this.$$( '<form>' );
this.closeButton = new ve.ui.IconButtonWidget( {
'$$': this.$$, 'icon': 'previous', 'title': ve.msg( 'visualeditor-inspector-close-tooltip' )
} );
this.removeButton = new ve.ui.IconButtonWidget( {
'$$': this.$$, 'icon': 'remove', 'title': ve.msg( 'visualeditor-inspector-remove-tooltip' )
} );
// Events
this.$form.on( {
'submit': ve.bind( this.onFormSubmit, this ),
'keydown': ve.bind( this.onFormKeyDown, this )
} );
this.closeButton.connect( this, { 'click': 'onCloseButtonClick' } );
this.removeButton.connect( this, { 'click': 'onRemoveButtonClick' } );
// Initialization
this.closeButton.$.addClass( 've-ui-inspector-closeButton' );
this.removeButton.$.addClass( 've-ui-inspector-removeButton' );
this.$head.prepend( this.closeButton.$ ).append( this.removeButton.$ );
this.$body.append( this.$form );
};
/**
* Handle close button click events.
*
* @method
*/
ve.ui.Inspector.prototype.onCloseButtonClick = function () {
this.close( 'back' );
};
/**
* Handle remove button click events.
*
* @method
*/
ve.ui.Inspector.prototype.onRemoveButtonClick = function () {
this.close( 'remove' );
};
/**
* Handle form submission events.
*
* @method
* @param {jQuery.Event} e Form submit event
*/
ve.ui.Inspector.prototype.onFormSubmit = function () {
this.close( 'apply' );
return false;
};
/**
* Handle form keydown events.
*
* @method
* @param {jQuery.Event} e Key down event
*/
ve.ui.Inspector.prototype.onFormKeyDown = function ( e ) {
// Escape
if ( e.which === 27 ) {
this.close( 'back' );
return false;
}
};
/**
* Handle inspector setup events.
*
* @method
*/
ve.ui.Inspector.prototype.onSetup = function () {
this.previousSelection = this.surface.getModel().getSelection();
};
/**
* Handle inspector open events.
*
* @method
*/
ve.ui.Inspector.prototype.onOpen = function () {
this.initialSelection = this.surface.getModel().getSelection();
};
/* Initialization */
ve.ui.Inspector.static.addLocalStylesheets( [ 've.ui.Inspector.css' ] );