mediawiki-extensions-Visual.../modules/ve/ui/ve.ui.Inspector.js
Trevor Parscal b3281bd87a Spell removable and movable using modern English
Also...

* Update OOjs UI to v0.1.0-pre (5ffe63d088)
* Make template parameter text boxes shorter (3em down from 10em)
* Reorder extendObject calls to not modify incoming config objects
* Allow level option to default to 0, rather than specifically defining it
* Use icon button widgets with remove icons for parameter, placeholder,
  template and content removal buttons

Change-Id: I29db9d814fab5cf4debd0fc7bab6f51475cb0f94
2013-12-06 12:24:36 -08:00

168 lines
3.7 KiB
JavaScript

/*!
* VisualEditor UserInterface Inspector class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Non-modal interface in a child frame.
*
* @class
* @abstract
* @extends OO.ui.Window
*
* @constructor
* @param {OO.ui.WindowSet} windowSet Window set this dialog is part of
* @param {Object} [config] Configuration options
*/
ve.ui.Inspector = function VeUiInspector( windowSet, config ) {
// Parent constructor
OO.ui.Window.call( this, windowSet, config );
// Properties
this.surface = windowSet.getSurface();
// Initialization
this.$element.addClass( 've-ui-inspector' );
};
/* Inheritance */
OO.inheritClass( ve.ui.Inspector, OO.ui.Window );
/* Static Properties */
ve.ui.Inspector.static.titleMessage = 've-ui-inspector-title';
/**
* Symbolic name of dialog.
*
* @abstract
* @static
* @property {string}
* @inheritable
*/
ve.ui.Inspector.static.name = '';
/**
* The inspector comes with a remove button
* @static
* @inheritable
* @property {boolean}
*/
ve.ui.Inspector.static.removable = true;
/* Methods */
/**
* Handle close button click events.
*
* @method
*/
ve.ui.Inspector.prototype.onCloseButtonClick = function () {
this.close( { 'action': 'back' } );
};
/**
* Handle remove button click events.
*
* @method
*/
ve.ui.Inspector.prototype.onRemoveButtonClick = function () {
this.close( { 'action': 'remove' } );
};
/**
* Handle form submission events.
*
* @method
* @param {jQuery.Event} e Form submit event
*/
ve.ui.Inspector.prototype.onFormSubmit = function () {
this.close( { 'action': '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 === OO.ui.Keys.ESCAPE ) {
this.close( { 'action': 'back' } );
return false;
}
};
/**
* @inheritdoc
*/
ve.ui.Inspector.prototype.initialize = function () {
// Parent method
OO.ui.Window.prototype.initialize.call( this );
// Initialization
this.frame.$content.addClass( 've-ui-inspector-content' );
this.$form = this.$( '<form>' );
this.closeButton = new OO.ui.IconButtonWidget( {
'$': this.$, 'icon': 'previous', 'title': ve.msg( 'visualeditor-inspector-close-tooltip' )
} );
if ( this.constructor.static.removable ) {
this.removeButton = new OO.ui.IconButtonWidget( {
'$': this.$, 'icon': 'remove', 'title': ve.msg( 'visualeditor-inspector-remove-tooltip' )
} );
}
// Events
this.$form.on( {
'submit': OO.ui.bind( this.onFormSubmit, this ),
'keydown': OO.ui.bind( this.onFormKeyDown, this )
} );
this.closeButton.connect( this, { 'click': 'onCloseButtonClick' } );
if ( this.constructor.static.removable ) {
this.removeButton.connect( this, { 'click': 'onRemoveButtonClick' } );
}
// Initialization
this.closeButton.$element.addClass( 've-ui-inspector-closeButton' );
this.$head.prepend( this.closeButton.$element );
if ( this.constructor.static.removable ) {
this.removeButton.$element.addClass( 've-ui-inspector-removeButton' );
this.$head.append( this.removeButton.$element );
}
this.$body.append( this.$form );
};
/**
* @inheritdoc
*/
ve.ui.Inspector.prototype.setup = function ( data ) {
// Parent method
OO.ui.Window.prototype.setup.call( this, data );
// Wait for animation to complete
setTimeout( ve.bind( function () {
this.ready();
}, this ), 200 );
};
/**
* Inspector is done animating and ready to be interacted with.
*/
ve.ui.Inspector.prototype.ready = function () {
//
};
/**
* @inheritdoc
*/
ve.ui.Inspector.prototype.teardown = function ( data ) {
// Parent method
OO.ui.Window.prototype.teardown.call( this, data );
};