mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-25 06:46:26 +00:00
4192cbc4d5
Changes: * Cleanup the window API to use more consistent and intuitive methods - we now use initialize/setup/teardown instead of initialize/onSetup/onOpen/onClose as methods which are overridden, and use open/close methods to control the window * Change events around to have opening/open and closing/close events which act as before/after points during the opening/closing process * Make WindowSet and Context respond to windows being opened, rather than opening them directly * Fix a LinkInspector creation mode bug where the initial text doesn't get reset * Move inspector, a VisualEditor concept, back to VE * Cleanup naming of SurfaceDialog, SurfaceToolbar, etc. to use shorter names, they were given Surface* names when the generic ones were also in VE, but now the generic ones are in OO, so they can return to their original names Change-Id: I82c4fed8bcb3fb5630938c8bc4dd9b2d5f1a8c1d
157 lines
3.6 KiB
JavaScript
157 lines
3.6 KiB
JavaScript
/*!
|
|
* ObjectOriented UserInterface WindowSet class.
|
|
*
|
|
* @copyright 2011-2013 OOJS Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Set of mutually exclusive windows.
|
|
*
|
|
* @class
|
|
* @extends OO.ui.Element
|
|
* @mixins OO.EventEmitter
|
|
*
|
|
* @constructor
|
|
* @param {OO.Factory} factory Window factory
|
|
* @param {Object} [config] Configuration options
|
|
*/
|
|
OO.ui.WindowSet = function OoUiWindowSet( factory, config ) {
|
|
// Parent constructor
|
|
OO.ui.Element.call( this, config );
|
|
|
|
// Mixin constructors
|
|
OO.EventEmitter.call( this );
|
|
|
|
// Properties
|
|
this.factory = factory;
|
|
this.windows = {};
|
|
this.currentWindow = null;
|
|
|
|
// Initialization
|
|
this.$element.addClass( 'oo-ui-windowSet' );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
OO.inheritClass( OO.ui.WindowSet, OO.ui.Element );
|
|
|
|
OO.mixinClass( OO.ui.WindowSet, OO.EventEmitter );
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event opening
|
|
* @param {OO.ui.Window} win Window that's being opened
|
|
* @param {Object} config Window opening information
|
|
*/
|
|
|
|
/**
|
|
* @event open
|
|
* @param {OO.ui.Window} win Window that's been opened
|
|
* @param {Object} config Window opening information
|
|
*/
|
|
|
|
/**
|
|
* @event closing
|
|
* @param {OO.ui.Window} win Window that's being closed
|
|
* @param {Object} config Window closing information
|
|
*/
|
|
|
|
/**
|
|
* @event close
|
|
* @param {OO.ui.Window} win Window that's been closed
|
|
* @param {Object} config Window closing information
|
|
*/
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle a window that's being opened.
|
|
*
|
|
* @method
|
|
* @param {OO.ui.Window} win Window that's being opened
|
|
* @param {Object} [config] Window opening information
|
|
* @fires opening
|
|
*/
|
|
OO.ui.WindowSet.prototype.onWindowOpening = function ( win, config ) {
|
|
if ( this.currentWindow && this.currentWindow !== win ) {
|
|
this.currentWindow.close();
|
|
}
|
|
this.currentWindow = win;
|
|
this.emit( 'opening', win, config );
|
|
};
|
|
|
|
/**
|
|
* Handle a window that's been opened.
|
|
*
|
|
* @method
|
|
* @param {OO.ui.Window} win Window that's been opened
|
|
* @param {Object} [config] Window opening information
|
|
* @fires open
|
|
*/
|
|
OO.ui.WindowSet.prototype.onWindowOpen = function ( win, config ) {
|
|
this.emit( 'open', win, config );
|
|
};
|
|
|
|
/**
|
|
* Handle a window that's being closed.
|
|
*
|
|
* @method
|
|
* @param {OO.ui.Window} win Window that's being closed
|
|
* @param {Object} [config] Window closing information
|
|
* @fires closing
|
|
*/
|
|
OO.ui.WindowSet.prototype.onWindowClosing = function ( win, config ) {
|
|
this.currentWindow = null;
|
|
this.emit( 'closing', win, config );
|
|
};
|
|
|
|
/**
|
|
* Handle a window that's been closed.
|
|
*
|
|
* @method
|
|
* @param {OO.ui.Window} win Window that's been closed
|
|
* @param {Object} [config] Window closing information
|
|
* @fires close
|
|
*/
|
|
OO.ui.WindowSet.prototype.onWindowClose = function ( win, config ) {
|
|
this.emit( 'close', win, config );
|
|
};
|
|
|
|
/**
|
|
* Get the current window.
|
|
*
|
|
* @method
|
|
* @returns {OO.ui.Window} Current window
|
|
*/
|
|
OO.ui.WindowSet.prototype.getCurrentWindow = function () {
|
|
return this.currentWindow;
|
|
};
|
|
|
|
/**
|
|
* Return a given window.
|
|
*
|
|
* @param {string} name Symbolic name of window
|
|
* @return {OO.ui.Window} Window with specified name
|
|
*/
|
|
OO.ui.WindowSet.prototype.getWindow = function ( name ) {
|
|
var win;
|
|
|
|
if ( !this.factory.lookup( name ) ) {
|
|
throw new Error( 'Unknown window: ' + name );
|
|
}
|
|
if ( !( name in this.windows ) ) {
|
|
win = this.windows[name] = this.factory.create( name, this, { '$': this.$ } );
|
|
win.connect( this, {
|
|
'opening': [ 'onWindowOpening', win ],
|
|
'open': [ 'onWindowOpen', win ],
|
|
'closing': [ 'onWindowClosing', win ],
|
|
'close': [ 'onWindowClose', win ]
|
|
} );
|
|
this.$element.append( win.$element );
|
|
win.getFrame().load();
|
|
}
|
|
return this.windows[name];
|
|
};
|