mediawiki-extensions-Visual.../modules/ve/ui/ve.ui.Frame.js
Rob Moen c472b2fe4a Make local overlays local to surface and remove insane z-indexes
ve.ui.Surface.js
* Make local overlay a child of ve-ui-surface and a sibling to
  ve-ce-surface elements.
** This keeps local overlays relative to their surface and eliminates the
   need for insane z-indexes.

ve.ui.PopupWidget.js
* PopupWidget boundaries are now relative to ve-ce-surface and no longer
  protrude out

ve.ce.Node.css, ve.ui.Window.css
* Removal or replacement of insane z-indexes.

ve.ce.FocusableNode.js, ve.ce.ProtectedNode.js, ve.ce.ResizableNode.js,
ve.ui.Context.js
* Translate offsets from local overlay

ve.init.mw.ViewPageTarget-monobook.css,
ve.init.mw.ViewPageTarget-vector.css
* Skin specific z-indexes for global overlay

ve.init.mw.ViewPageTarget.js
* Applied direction specific mw class to ce.Surface vs ui.Surface to
  prevent mw content styles from being applied to ui elements.

ve.ui.Dialog.css
* Adjustments to surface inside of dialog so that relative offsets for
  local overlays can be properly calculated.

ve.ui.Surface.css
* Explicitly force .ve-ui-surface to be relative so that it's children can
  be relatively positioned.

ve.ui.Widget.css
* Removal of unnecessary font-size properties now that local overlay is
  sibling of surface.

ve.js
* Added get relative position helper method to translate position offsets
  from target parent

Bug: 50241
Change-Id: Ibadce404a2286bc5dcec48f0d9da89004dbbd867
2013-07-02 19:35:43 +00:00

148 lines
3.7 KiB
JavaScript

/*!
* VisualEditor UserInterface Frame class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* UserInterface iframe abstraction.
*
* @class
* @extends ve.Element
* @mixins ve.EventEmitter
*
* @constructor
* @param {Object} [config] Config options
* @cfg {string[]} [stylesheets] List of stylesheet file names, each relative to ve/ui/styles
*/
ve.ui.Frame = function VeUiFrame( config ) {
// Parent constructor
ve.Element.call( this, config );
// Mixin constructors
ve.EventEmitter.call( this );
// Properties
this.initialized = false;
this.config = config;
// Initialize
this.$
.addClass( 've-ui-frame' )
.attr( { 'frameborder': 0, 'scrolling': 'no' } );
};
/* Inheritance */
ve.inheritClass( ve.ui.Frame, ve.Element );
ve.mixinClass( ve.ui.Frame, ve.EventEmitter );
/* Static Properties */
ve.ui.Frame.static.tagName = 'iframe';
/* Events */
/**
* @event initialize
*/
/* Methods */
/**
* Load the frame contents.
*
* Once the iframe's stylesheets are loaded, the `initialize` event will be emitted.
*
* Sounds simple right? Read on...
*
* When you create a dynamic iframe using open/write/close, the window.load event for the
* iframe is triggered when you call close, and there's no further load event to indicate that
* everything is actually loaded.
*
* By dynamically adding stylesheet links, we can detect when each link is loaded by testing if we
* have access to each of their `sheet.cssRules` properties. Every 10ms we poll to see if we have
* access to the style's `sheet.cssRules` property yet.
*
* However, because of security issues, we never have such access if the stylesheet came from a
* different site. Thus, we are left with linking to the stylesheets through a style element with
* multiple `@import` statements - which ends up being simpler anyway. Since we created that style,
* we always have access, and its contents are only available when everything is done loading.
*
* @emits initialize
*/
ve.ui.Frame.prototype.load = function () {
var interval, rules,
win = this.$.prop( 'contentWindow' ),
doc = win.document,
style = doc.createElement( 'style' ),
initialize = ve.bind( function () {
this.initialized = true;
this.emit( 'initialize' );
}, this );
// Initialize contents
doc.open();
doc.write(
'<!doctype html>' +
'<html>' +
'<body style="padding:0;margin:0;">' +
'<div class="ve-ui-frame-content"></div>' +
'</body>' +
'</html>'
);
doc.close();
// Import all stylesheets
style.textContent = '@import "' + this.config.stylesheets.join( '";\n@import "' ) + '";';
doc.body.appendChild( style );
// Poll for access to stylesheet content
interval = setInterval( ve.bind( function () {
try {
// MAGIC: only accessible when the stylesheet is loaded
rules = style.sheet.cssRules;
} catch ( e ) {
// Try again in 10ms
return;
}
// If that didn't throw an exception, we're done loading
clearInterval( interval );
// Protect against IE running interval one extra time after clearing
if ( !this.initialized ) {
initialize();
}
}, this ), 10 );
// Properties
this.$$ = ve.Element.get$$( doc, this );
this.$content = this.$$( '.ve-ui-frame-content' );
this.$document = this.$$( doc );
};
/**
* @param {Function} callback
*/
ve.ui.Frame.prototype.run = function ( callback ) {
if ( this.initialized ) {
callback();
} else {
this.once( 'initialize', callback );
}
};
/**
* Sets the size of the frame.
*
* @method
* @param {number} width Frame width in pixels
* @param {number} height Frame height in pixels
* @chainable
*/
ve.ui.Frame.prototype.setSize = function ( width, height ) {
this.$.css( { 'width': width, 'height': height } );
return this;
};