mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 12:16:51 +00:00
301 lines
8 KiB
JavaScript
301 lines
8 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable BranchNode class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable branch node.
|
|
*
|
|
* Branch nodes can have branch or leaf nodes as children.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @extends ve.ce.Node
|
|
* @mixins ve.BranchNode
|
|
* @constructor
|
|
* @param {ve.dm.BranchNode} model Model to observe
|
|
* @param {Object} [config] Configuration options
|
|
*/
|
|
ve.ce.BranchNode = function VeCeBranchNode( model, config ) {
|
|
// Mixin constructor
|
|
ve.BranchNode.call( this );
|
|
|
|
// Parent constructor
|
|
ve.ce.Node.call( this, model, config );
|
|
|
|
// Properties
|
|
this.tagName = this.$.get( 0 ).nodeName.toLowerCase();
|
|
this.slugs = {};
|
|
|
|
// Events
|
|
this.model.connect( this, { 'splice': 'onSplice' } );
|
|
|
|
// Initialization
|
|
this.onSplice.apply( this, [0, 0].concat( model.getChildren() ) );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ce.BranchNode, ve.ce.Node );
|
|
|
|
ve.mixinClass( ve.ce.BranchNode, ve.BranchNode );
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event rewrap
|
|
* @param {jQuery} $old
|
|
* @param {jQuery} $new
|
|
*/
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* Inline slug template.
|
|
*
|
|
* TODO: Make iframe safe
|
|
*
|
|
* @static
|
|
* @property {jQuery}
|
|
*/
|
|
ve.ce.BranchNode.$inlineSlugTemplate = $( '<span>' )
|
|
.addClass( 've-ce-branchNode-slug ve-ce-branchNode-inlineSlug' )
|
|
.html( $.browser.msie ? ' ' : '' );
|
|
|
|
/**
|
|
* Block slug template.
|
|
*
|
|
* TODO: Make iframe safe
|
|
*
|
|
* @static
|
|
* @property {jQuery}
|
|
*/
|
|
ve.ce.BranchNode.$blockSlugTemplate = $( '<span>' )
|
|
.addClass( 've-ce-branchNode-slug ve-ce-branchNode-blockSlug' )
|
|
.html( $.browser.msie ? ' ' : '' );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle setup event.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.BranchNode.prototype.onSetup = function () {
|
|
ve.ce.Node.prototype.onSetup.call( this );
|
|
this.$.addClass( 've-ce-branchNode' );
|
|
};
|
|
|
|
/**
|
|
* Handle teardown event.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.BranchNode.prototype.onTeardown = function () {
|
|
ve.ce.Node.prototype.onTeardown.call( this );
|
|
this.$.removeClass( 've-ce-branchNode' );
|
|
};
|
|
|
|
/**
|
|
* Update the DOM wrapper.
|
|
*
|
|
* WARNING: The contents, .data( 'view' ) and any classes the wrapper already has will be moved to
|
|
* the new wrapper, but other attributes and any other information added using $.data() will be
|
|
* lost upon updating the wrapper. To retain information added to the wrapper, subscribe to the
|
|
* 'rewrap' event and copy information from the {$old} wrapper the {$new} wrapper.
|
|
*
|
|
* @method
|
|
* @emits rewrap
|
|
*/
|
|
ve.ce.BranchNode.prototype.updateTagName = function () {
|
|
var $element,
|
|
tagName = this.getTagName();
|
|
|
|
if ( tagName !== this.tagName ) {
|
|
this.emit( 'teardown' );
|
|
$element = this.$$( this.$$.context.createElement( tagName ) );
|
|
// Move contents
|
|
$element.append( this.$.contents() );
|
|
// Swap elements
|
|
this.$.replaceWith( $element );
|
|
// Use new element from now on
|
|
this.$ = $element;
|
|
this.emit( 'setup' );
|
|
// Remember which tag name we are using now
|
|
this.tagName = tagName;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Handles model update events.
|
|
*
|
|
* @param {ve.dm.Transaction} transaction
|
|
*/
|
|
ve.ce.BranchNode.prototype.onModelUpdate = function ( transaction ) {
|
|
this.emit( 'childUpdate', transaction );
|
|
};
|
|
|
|
/**
|
|
* Handle splice events.
|
|
*
|
|
* ve.ce.Node objects are generated from the inserted ve.dm.Node objects, producing a view that's a
|
|
* mirror of its model.
|
|
*
|
|
* @method
|
|
* @param {number} index Index to remove and or insert nodes at
|
|
* @param {number} howmany Number of nodes to remove
|
|
* @param {ve.dm.BranchNode...} [nodes] Variadic list of nodes to insert
|
|
*/
|
|
ve.ce.BranchNode.prototype.onSplice = function ( index ) {
|
|
var i, j,
|
|
length,
|
|
args = Array.prototype.slice.call( arguments ),
|
|
$anchor,
|
|
afterAnchor,
|
|
node,
|
|
parentNode,
|
|
firstChild,
|
|
removals;
|
|
// Convert models to views and attach them to this node
|
|
if ( args.length >= 3 ) {
|
|
for ( i = 2, length = args.length; i < length; i++ ) {
|
|
args[i] = ve.ce.nodeFactory.create( args[i].getType(), args[i] );
|
|
args[i].model.connect( this, { 'update': 'onModelUpdate' } );
|
|
}
|
|
}
|
|
removals = this.children.splice.apply( this.children, args );
|
|
for ( i = 0, length = removals.length; i < length; i++ ) {
|
|
removals[i].model.disconnect( this, { 'update': 'onModelUpdate' } );
|
|
removals[i].setLive( false );
|
|
removals[i].detach();
|
|
removals[i].$.detach();
|
|
}
|
|
if ( args.length >= 3 ) {
|
|
if ( index ) {
|
|
// Get the element before the insertion point
|
|
$anchor = this.children[ index - 1 ].$.last();
|
|
}
|
|
for ( i = args.length - 1; i >= 2; i-- ) {
|
|
args[i].attach( this );
|
|
if ( index ) {
|
|
// DOM equivalent of $anchor.after( args[i].$ );
|
|
afterAnchor = $anchor[0].nextSibling;
|
|
parentNode = $anchor[0].parentNode;
|
|
for ( j = 0, length = args[i].$.length; j < length; j++ ) {
|
|
parentNode.insertBefore( args[i].$[j], afterAnchor );
|
|
}
|
|
} else {
|
|
// DOM equivalent of this.$.prepend( args[j].$ );
|
|
node = this.$[0];
|
|
firstChild = node.firstChild;
|
|
for ( j = args[i].$.length - 1; j >= 0; j-- ) {
|
|
node.insertBefore( args[i].$[j], firstChild );
|
|
}
|
|
}
|
|
if ( this.live !== args[i].isLive() ) {
|
|
args[i].setLive( this.live );
|
|
}
|
|
}
|
|
}
|
|
|
|
this.setupSlugs();
|
|
};
|
|
|
|
/**
|
|
* Setup slugs where needed.
|
|
*
|
|
* Existing slugs will be removed before new ones are added.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.BranchNode.prototype.setupSlugs = function () {
|
|
var key, slug, i, len, first, last, doc = this.getElementDocument();
|
|
|
|
// Remove all slugs in this branch
|
|
for ( key in this.slugs ) {
|
|
if ( this.slugs[key].parentNode ) {
|
|
this.slugs[key].parentNode.removeChild( this.slugs[key] );
|
|
}
|
|
delete this.slugs[key];
|
|
}
|
|
|
|
if ( this.canHaveChildrenNotContent() ) {
|
|
slug = ve.ce.BranchNode.$blockSlugTemplate[0];
|
|
} else {
|
|
slug = ve.ce.BranchNode.$inlineSlugTemplate[0];
|
|
}
|
|
|
|
// If this content branch no longer has any rendered children, insert a slug to keep the node
|
|
// from becoming invisible/unfocusable. In Firefox, backspace after Ctrl-A leaves the document
|
|
// completely empty, so this ensures DocumentNode gets a slug.
|
|
// Can't use this.getLength() because the internal list adds to the length but doesn't render.
|
|
if ( this.$.contents().length === 0 ) {
|
|
this.slugs[0] = doc.importNode( slug, true );
|
|
this.$[0].appendChild( this.slugs[0] );
|
|
} else {
|
|
// Iterate over all children of this branch and add slugs in appropriate places
|
|
for ( i = 0, len = this.children.length; i < len; i++ ) {
|
|
// Don't put slugs after internal nodes.
|
|
if ( ve.dm.nodeFactory.isNodeInternal( this.children[i].model.type ) ) {
|
|
continue;
|
|
}
|
|
// First sluggable child (left side)
|
|
if ( i === 0 && this.children[i].canHaveSlugBefore() ) {
|
|
this.slugs[i] = doc.importNode( slug, true );
|
|
first = this.children[i].$[0];
|
|
first.parentNode.insertBefore( this.slugs[i], first );
|
|
}
|
|
if ( this.children[i].canHaveSlugAfter() ) {
|
|
if (
|
|
// Last sluggable child (right side)
|
|
i === this.children.length - 1 ||
|
|
// Sluggable child followed by another sluggable child (in between)
|
|
( this.children[i + 1] && this.children[i + 1].canHaveSlugBefore() )
|
|
) {
|
|
this.slugs[i + 1] = doc.importNode( slug, true );
|
|
last = this.children[i].$[this.children[i].$.length - 1];
|
|
last.parentNode.insertBefore( this.slugs[i + 1], last.nextSibling );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Get a slug at an offset.
|
|
*
|
|
* @method
|
|
* @param {number} offset Offset to get slug at
|
|
* @returns {HTMLElement}
|
|
*/
|
|
ve.ce.BranchNode.prototype.getSlugAtOffset = function ( offset ) {
|
|
var i,
|
|
startOffset = this.model.getOffset() + ( this.isWrapped() ? 1 : 0 );
|
|
|
|
if ( offset === startOffset ) {
|
|
return this.slugs[0] || null;
|
|
}
|
|
for ( i = 0; i < this.children.length; i++ ) {
|
|
startOffset += this.children[i].model.getOuterLength();
|
|
if ( offset === startOffset ) {
|
|
return this.slugs[i + 1] || null;
|
|
}
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Set live state on child nodes.
|
|
*
|
|
* @method
|
|
* @param {boolean} live New live state
|
|
* @emits live
|
|
*/
|
|
ve.ce.BranchNode.prototype.setLive = function ( live ) {
|
|
ve.ce.Node.prototype.setLive.call( this, live );
|
|
for ( var i = 0; i < this.children.length; i++ ) {
|
|
this.children[i].setLive( live );
|
|
}
|
|
};
|