mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-01 17:36:35 +00:00
2e76271b4e
Prologue: Farewell ve.Editor my good chap… Oh, hey there HTML frames - I didn't see you there! In a world where iframes are outlaws, and symbols like document and window are global, there were more than a few assumptions about which document or window was being used. But fear not - for this commit (probably) tracks them all down, leaving a trail of iframe-compatible awesomeness in its wake. With the great ve.ui.Surface now able to be used inside of iframes, let the reference editing commence. But there, lurking in the darkness is a DM issue so fierce it may take Roan and/or Ed up to 3 whole hours to sort it out. Note to Roan and/or Ed: Editing references seems to work fine, but when saving the page there are "no changes" which is a reasonable indication to the contrary. Objectives: * Make it possible to have multiple surfaces be instantiated, get along nicely, and be embedded inside of iframes if needed. * Make reference content editable within a dialog Approach: * Move what's left of ve.Editor to ve.ui.Surface and essentially obliterate all use of it * Make even more stuff inherit from ve.Element (long live this.$$) * Use the correct document or window anywhere it was being assumed to be the top level one * Resolve stacking order issues by removing the excessive use of z-index and introducing global and local overlay elements for each editor * Add a surface to the reference dialog, load up the reference contents and save them back on apply * Actually destroy what we create in ce and ui surfaces * Add recursive frame offset calculation method to ve.Element * Moved ve.ce.Surface's getSelectionRect method to the prototype Bonus: * Move ve.ce.DocumentNode.css contents to ve.ce.Node.css (not sure why it was separate in the first place, but I'm likely the one to blame) * Fix blatant lies in documentation * Whitespace cleanup here and there * Get rid of ve.ui.Window overlays - not used or needed Change-Id: Iede83e7d24f7cb249b6ba3dc45d770445b862e08
132 lines
3.2 KiB
JavaScript
132 lines
3.2 KiB
JavaScript
/*!
|
|
* VisualEditor user interface MWReferenceDialog class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Document dialog.
|
|
*
|
|
* @class
|
|
* @extends ve.ui.Dialog
|
|
*
|
|
* @constructor
|
|
* @param {ve.ui.Surface} surface
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.MWReferenceDialog = function VeUiMWReferenceDialog( surface, config ) {
|
|
// Parent constructor
|
|
ve.ui.Dialog.call( this, surface, config );
|
|
|
|
// Properties
|
|
this.referenceNode = null;
|
|
this.internalItem = null;
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.MWReferenceDialog, ve.ui.Dialog );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ui.MWReferenceDialog.static.titleMessage = 'visualeditor-dialog-reference-title';
|
|
|
|
ve.ui.MWReferenceDialog.static.icon = 'reference';
|
|
|
|
ve.ui.MWReferenceDialog.static.modelClasses = [ ve.dm.MWReferenceNode ];
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle frame ready events.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.MWReferenceDialog.prototype.initialize = function () {
|
|
// Call parent method
|
|
ve.ui.Dialog.prototype.initialize.call( this );
|
|
|
|
// Initialization
|
|
this.$body.addClass( 've-ui-mwReferenceDialog-body' );
|
|
};
|
|
|
|
/**
|
|
* Handle frame ready events.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.MWReferenceDialog.prototype.onOpen = function () {
|
|
var doc = this.surface.getModel().getDocument();
|
|
|
|
// Parent method
|
|
ve.ui.Dialog.prototype.onOpen.call( this );
|
|
|
|
this.referenceNode = this.surface.getView().getFocusedNode();
|
|
this.internalItem = this.referenceNode.getModel().getInternalItem();
|
|
|
|
// Properties
|
|
this.referenceSurface = new ve.ui.Surface(
|
|
// TODO: Move these details into something like ve.dm.SurfaceFragment
|
|
new ve.dm.ElementLinearData(
|
|
doc.getStore(), doc.getData( this.internalItem.getRange(), true )
|
|
),
|
|
{ '$$': this.frame.$$ }
|
|
);
|
|
this.referenceToolbar = new ve.ui.Toolbar(
|
|
this.referenceSurface, { '$$': this.frame.$$ }
|
|
);
|
|
|
|
// Initialization
|
|
this.referenceToolbar.$.addClass( 've-ui-mwReferenceDialog-toolbar' );
|
|
this.$body.append( this.referenceToolbar.$, this.referenceSurface.$ );
|
|
this.referenceToolbar.addTools( ve.init.mw.ViewPageTarget.static.toolbarTools );
|
|
this.referenceSurface.addCommands( ve.init.mw.ViewPageTarget.static.surfaceCommands );
|
|
this.referenceSurface.initialize();
|
|
};
|
|
|
|
/**
|
|
* Handle frame ready events.
|
|
*
|
|
* @method
|
|
* @param {string} action Action that caused the window to be closed
|
|
*/
|
|
ve.ui.MWReferenceDialog.prototype.onClose = function ( action ) {
|
|
var tx,
|
|
doc = this.surface.getModel().getDocument();
|
|
|
|
// Parent method
|
|
ve.ui.Dialog.prototype.onOpen.call( this );
|
|
|
|
// TODO: Make this actually work
|
|
if ( action === 'apply' ) {
|
|
tx = ve.dm.Transaction.newFromNodeReplacement(
|
|
doc,
|
|
this.internalItem.getRange(),
|
|
this.referenceSurface.getModel().getDocument().getData()
|
|
);
|
|
this.surface.getModel().change( tx );
|
|
}
|
|
|
|
// Cleanup
|
|
this.referenceSurface.destroy();
|
|
this.referenceToolbar.destroy();
|
|
};
|
|
|
|
/* Initialization */
|
|
|
|
ve.ui.MWReferenceDialog.static.addLocalStylesheets( [
|
|
've.ce.Node.css',
|
|
've.ce.Surface.css',
|
|
've.ui.Surface.css',
|
|
've.ui.Context.css',
|
|
've.ui.Tool.css',
|
|
've.ui.Toolbar.css'
|
|
] );
|
|
|
|
/* Registration */
|
|
|
|
ve.ui.dialogFactory.register( 'mwReference', ve.ui.MWReferenceDialog );
|
|
|
|
ve.ui.viewRegistry.register( 'mwReference', ve.ui.MWReferenceDialog );
|