mediawiki-extensions-Visual.../modules/ve/ce/ve.ce.ResizableNode.js
Trevor Parscal 2e76271b4e The Great ve.ui.Surface refactor of 2013
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
2013-05-24 14:01:02 +02:00

251 lines
6.8 KiB
JavaScript

/*!
* VisualEditor ContentEditable ResizableNode class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* ContentEditable resizable node.
*
* @class
* @abstract
*
* @constructor
* @param {jQuery} [$resizable=this.$] Resizable DOM element
*/
ve.ce.ResizableNode = function VeCeResizableNode( $resizable ) {
// Properties
this.$resizable = $resizable || this.$;
this.ratio = this.model.getAttribute( 'width' ) / this.model.getAttribute( 'height' );
this.resizing = false;
this.$resizeHandles = $( '<div>' );
// Events
this.connect( this, { 'focus': 'onResizableFocus', 'blur': 'onResizableBlur' } );
// Initialization
this.$resizeHandles
.addClass( 've-ce-resizableNode-handles' )
.append( $( '<div>' ).addClass( 've-ce-resizableNode-nwHandle' ) )
.append( $( '<div>' ).addClass( 've-ce-resizableNode-neHandle' ) )
.append( $( '<div>' ).addClass( 've-ce-resizableNode-seHandle' ) )
.append( $( '<div>' ).addClass( 've-ce-resizableNode-swHandle' ) )
.children()
.on( {
'mousedown': ve.bind( this.onResizeHandlesCornerMouseDown, this )
} );
};
/* Methods */
/**
* Handle node focus.
*
* @method
*/
ve.ce.ResizableNode.prototype.onResizableFocus = function () {
var offset = this.$resizable.offset();
this.$resizeHandles
.css( {
'width': 0,
'height': 0,
'top': offset.top,
'left': offset.left
} )
.appendTo( $( 'body' ) );
this.$resizeHandles
.find('.ve-ce-resizableNode-neHandle').css( {
'margin-right': -this.$resizable.width()
} ).end()
.find('.ve-ce-resizableNode-swHandle').css( {
'margin-bottom': -this.$resizable.height()
} ).end()
.find('.ve-ce-resizableNode-seHandle').css( {
'margin-right': -this.$resizable.width(),
'margin-bottom': -this.$resizable.height()
} );
};
/**
* Handle node blur.
*
* @method
*/
ve.ce.ResizableNode.prototype.onResizableBlur = function () {
this.$resizeHandles.detach();
};
/**
* Handle bounding box handle mousedown.
*
* @method
* @param {jQuery.Event} e Click event
*/
ve.ce.ResizableNode.prototype.onResizeHandlesCornerMouseDown = function ( e ) {
// Hide context menu
// TODO: Maybe there's a more generic way to handle this sort of thing? For relocation it's
// handled in ve.ce.Surface
this.root.getSurface().getSurface().getContext().hide();
// Set bounding box width and undo the handle margins
this.$resizeHandles
.addClass( 've-ce-resizableNode-handles-resizing' )
.css( {
'width': this.$resizable.width(),
'height': this.$resizable.height()
} );
this.$resizeHandles.children().css( 'margin', 0 );
// Values to calculate adjusted bounding box size
this.resizeInfo = {
'mouseX': e.screenX,
'mouseY': e.screenY,
'top': this.$resizeHandles.position().top,
'left': this.$resizeHandles.position().left,
'height': this.$resizeHandles.height(),
'width': this.$resizeHandles.width(),
'handle': e.target.className,
};
// Bind resize events
this.resizing = true;
$( this.getElementDocument() ).on( {
'mousemove.ve-ce-resizableNode': ve.bind( this.onDocumentMouseMove, this ),
'mouseup.ve-ce-resizableNode': ve.bind( this.onDocumentMouseUp, this )
} );
return false;
};
/**
* Handle body mousemove.
*
* @method
* @param {jQuery.Event} e Click event
*/
ve.ce.ResizableNode.prototype.onDocumentMouseMove = function ( e ) {
var newWidth, newHeight, newRatio,
// TODO: Make these configurable
min = 1,
max = 1000,
diff = {},
dimensions = {
'width': 0,
'height': 0,
'top': this.resizeInfo.top,
'left': this.resizeInfo.left
};
if ( this.resizing ) {
// X and Y diff
switch ( this.resizeInfo.handle ) {
case 've-ce-resizableNode-seHandle':
diff.x = e.screenX - this.resizeInfo.mouseX;
diff.y = e.screenY - this.resizeInfo.mouseY;
break;
case 've-ce-resizableNode-nwHandle':
diff.x = this.resizeInfo.mouseX - e.screenX;
diff.y = this.resizeInfo.mouseY - e.screenY;
break;
case 've-ce-resizableNode-neHandle':
diff.x = e.screenX - this.resizeInfo.mouseX;
diff.y = this.resizeInfo.mouseY - e.screenY;
break;
case 've-ce-resizableNode-swHandle':
diff.x = this.resizeInfo.mouseX - e.screenX;
diff.y = e.screenY - this.resizeInfo.mouseY;
break;
}
// Unconstrained dimensions and ratio
newWidth = Math.max( Math.min( this.$resizable.width() + diff.x, max ), min );
newHeight = Math.max( Math.min( this.$resizable.height() + diff.y, max ), min );
newRatio = newWidth / newHeight;
// Fix the ratio
if ( this.ratio > newRatio ) {
dimensions.width = newWidth;
dimensions.height = this.$resizable.height() +
( newWidth - this.$resizable.width() ) / this.ratio;
} else {
dimensions.width = this.$resizable.width() +
( newHeight - this.$resizable.height() ) * this.ratio;
dimensions.height = newHeight;
}
// Fix the position
switch ( this.resizeInfo.handle ) {
case 've-ce-resizableNode-neHandle':
dimensions.top = this.resizeInfo.top +
( this.resizeInfo.height - dimensions.height );
break;
case 've-ce-resizableNode-swHandle':
dimensions.left = this.resizeInfo.left +
( this.resizeInfo.width - dimensions.width );
break;
case 've-ce-resizableNode-nwHandle':
dimensions.top = this.resizeInfo.top +
( this.resizeInfo.height - dimensions.height );
dimensions.left = this.resizeInfo.left +
( this.resizeInfo.width - dimensions.width );
break;
}
// Update bounding box
this.$resizeHandles.css( dimensions );
}
};
/**
* Handle body mouseup.
*
* @method
*/
ve.ce.ResizableNode.prototype.onDocumentMouseUp = function () {
var offset = this.model.getOffset(),
width = this.$resizeHandles.outerWidth(),
height = this.$resizeHandles.outerHeight(),
surfaceModel = this.getRoot().getSurface().getModel(),
documentModel = surfaceModel.getDocument(),
selection = surfaceModel.getSelection();
this.$resizeHandles.removeClass( 've-ce-resizableNode-handles-resizing' );
$( this.getElementDocument() ).off( '.ve-ce-resizableNode' );
this.resizing = false;
// Transition image resize
this.$resizable
.addClass( 've-ce-resizableNode-transitioning' )
.css( { 'width': width, 'height': height } );
// Allow resize to occur before re-rendering
setTimeout( ve.bind( function () {
var txs = [];
// Prevent further transitioning
this.$resizable.removeClass( 've-ce-resizableNode-transitioning' );
// Apply changes to the model
if ( this.model.getAttribute( 'width' ) !== width ) {
txs.push( ve.dm.Transaction.newFromAttributeChange(
documentModel, offset, 'width', width
) );
}
if ( this.model.getAttribute( 'height' ) !== height ) {
txs.push( ve.dm.Transaction.newFromAttributeChange(
documentModel, offset, 'height', height
) );
}
if ( txs.length > 0 ) {
surfaceModel.change( txs, selection );
}
// HACK: Update bounding box
this.onResizableFocus();
}, this ), 200 );
};