mediawiki-extensions-Visual.../modules/ve/ve.Element.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

202 lines
4.4 KiB
JavaScript

/*!
* VisualEditor UserInterface Element class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.Element object.
*
* @class
* @abstract
*
* @constructor
* @param {Object} [config] Config options
* @cfg {Function} [$$] jQuery for the frame the widget is in
*/
ve.Element = function VeElement( config ) {
// Initialize config
config = config || {};
// Properties
this.$$ = config.$$ || ve.Element.get$$( document );
this.$ = this.$$( this.$$.context.createElement( this.getTagName() ) );
};
/* Static Properties */
/**
* @static
* @property
* @inheritable
*/
ve.Element.static = {};
/**
* HTML tag name.
*
* This may be ignored if getTagName is overridden.
*
* @static
* @property {string}
* @inheritable
*/
ve.Element.static.tagName = 'div';
/* Static Methods */
/**
* Gets a jQuery function within a specific document.
*
* @method
* @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
* @param {ve.ui.Frame} [frame] Frame of the document context
* @returns {Function} Bound jQuery function
*/
ve.Element.get$$ = function ( context, frame ) {
function wrapper( selector ) {
return $( selector, wrapper.context );
}
wrapper.context = this.getDocument( context );
if ( frame ) {
wrapper.frame = frame;
}
return wrapper;
};
/**
* Get the document of an element.
*
* @method
* @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
* @returns {HTMLDocument} Document object
* @throws {Error} If context is invalid
*/
ve.Element.getDocument = function ( context ) {
var doc =
// jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
( context[0] && context[0].ownerDocument ) ||
// Empty jQuery selections might have a context
context.context ||
// HTMLElement
context.ownerDocument ||
// Window
context.document ||
// HTMLDocument
( context.nodeType === 9 && context );
if ( doc ) {
return doc;
}
throw new Error( 'Invalid context' );
};
/**
* Get the window of an element or document.
*
* @method
* @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
* @returns {Window} Window object
*/
ve.Element.getWindow = function ( context ) {
var doc = this.getDocument( context );
return doc.parentWindow || doc.defaultView;
};
/**
* Get the offset between two frames.
*
* TODO: Make this function not use recursion.
*
* @method
* @param {Window} from Window of the child frame
* @param {Window} [to=window] Window of the parent frame
* @param {Object} [offset] Offset to start with, used internally
* @returns {Object} Offset object, containing left and top properties
*/
ve.Element.getFrameOffset = function ( from, to, offset ) {
var i, len, frames, frame, rect;
if ( !to ) {
to = window;
}
if ( !offset ) {
offset = { 'top': 0, 'left': 0 };
}
if ( from.parent === from ) {
return offset;
}
// Get iframe element
frames = from.parent.document.getElementsByTagName( 'iframe' );
for ( i = 0, len = frames.length; i < len; i++ ) {
if ( frames[i].contentWindow === from ) {
frame = frames[i];
break;
}
}
// Recursively accumulate offset values
if ( frame ) {
rect = frame.getBoundingClientRect();
offset.left += rect.left;
offset.top += rect.top;
if ( from !== to ) {
this.getFrameOffset( from.parent, offset );
}
}
return offset;
};
/**
* Get the offset between two elements.
*
* @param {jQuery} $from
* @param {jQuery} $to
* @returns {Object} Translated position coordinates, containing top and left properties
*/
ve.Element.getRelativePosition = function ( $from, $to ) {
var from = $from.offset(),
to = $to.offset();
return { 'top': from.top - to.top, 'left': from.left - to.left };
};
/* Methods */
/**
* Get the HTML tag name.
*
* Override this method to base the result on instance information.
*
* @method
* @returns {string} HTML tag name
*/
ve.Element.prototype.getTagName = function () {
return this.constructor.static.tagName;
};
/**
* Get the DOM document.
*
* @method
* @returns {HTMLDocument} Document object
*/
ve.Element.prototype.getElementDocument = function () {
return ve.Element.getDocument( this.$ );
};
/**
* Get the DOM window.
*
* @method
* @returns {Window} Window object
*/
ve.Element.prototype.getElementWindow = function () {
return ve.Element.getWindow( this.$ );
};