/**
* VisualEditor content editable TextNode class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* ContentEditable node for text.
*
* @class
* @constructor
* @extends {ve.ce.LeafNode}
* @param {ve.dm.TextNode} model Model to observe
*/
ve.ce.TextNode = function VeCeTextNode( model ) {
// Parent constructor
ve.ce.LeafNode.call( this, 'text', model, $( document.createTextNode( '' ) ) );
// Events
this.model.addListenerMethod( this, 'update', 'onUpdate' );
// Initialization
this.onUpdate( true );
};
/* Inheritance */
ve.inheritClass( ve.ce.TextNode, ve.ce.LeafNode );
/* Static Members */
/**
* Node rules.
*
* @see ve.ce.NodeFactory
* @static
* @member
*/
ve.ce.TextNode.rules = {
'canBeSplit': true
};
/**
* Mapping of character and HTML entities or renderings.
*
* @static
* @member
*/
ve.ce.TextNode.htmlCharacters = {
'&': '&',
'<': '<',
'>': '>',
'\'': ''',
'"': '"',
'\n': '↵',
'\t': '➞'
};
/**
* List of annotation rendering implementations.
*
* Each supported annotation renderer must have an open and close property, each either a string or
* a function which accepts a data argument.
*
* @static
* @member
*/
ve.ce.TextNode.annotationRenderers = {
'textStyle/italic': {
'open': '',
'close': ''
},
'textStyle/bold': {
'open': '',
'close': ''
},
'textStyle/underline': {
'open': '',
'close': ''
},
'textStyle/strike': {
'open': '',
'close': ''
},
'textStyle/small': {
'open': '',
'close': ''
},
'textStyle/big': {
'open': '',
'close': ''
},
'textStyle/span': {
// TODO recognize attributes
'open': '',
'close': ''
},
'textStyle/strong': {
'open': '',
'close': ''
},
'textStyle/emphasize': {
'open': '',
'close': ''
},
'textStyle/superScript': {
'open': '',
'close': ''
},
'textStyle/subScript': {
'open': '',
'close': ''
},
'link/ExtLink': {
'open': function ( data ) {
return '';
},
'close': ''
},
'link/ExtLink/Numbered': {
'open': function ( data ) {
return '';
},
'close': ''
},
'link/ExtLink/URL': {
'open': function ( data ) {
return '';
},
'close': ''
},
'link/WikiLink': {
'open': function ( data ) {
return '';
},
'close': ''
},
'link/unknown': {
'open': function () {
return '';
},
'close': ''
}
};
/* Methods */
/**
* Responds to model update events.
*
* If the source changed since last update the image's src attribute will be updated accordingly.
*
* @method
*/
ve.ce.TextNode.prototype.onUpdate = function ( force ) {
if ( !force && !this.root.getSurface ) {
throw new Error( 'Can not update a text node that is not attached to a document' );
}
if ( force === true || !this.root.getSurface().isLocked() ) {
var $new = $( '' ).html( this.getHtml() ).contents();
if ( $new.length === 0 ) {
$new = $new.add( document.createTextNode( '' ) );
}
this.$.replaceWith( $new );
this.$ = $new;
if ( this.parent ) {
this.parent.clean();
if ( ve.debug ) {
this.parent.$.css( 'backgroundColor', '#F6F6F6' );
setTimeout( ve.bind( function () {
this.parent.$.css( 'backgroundColor', 'transparent' );
}, this ), 350 );
}
}
}
};
/**
* Gets an HTML rendering of data within content model.
*
* @method
* @param {String} Rendered HTML of data within content model
*/
ve.ce.TextNode.prototype.getHtml = function () {
var data = this.model.getDocument().getDataFromNode( this.model ),
htmlChars = ve.ce.TextNode.htmlCharacters,
renderers = ve.ce.TextNode.annotationRenderers,
out = '',
i,
j,
arr,
left = '',
right,
character,
nextCharacter,
open,
close,
startedClosing,
annotation,
leftPlain,
rightPlain,
annotationStack = new ve.AnnotationSet(),
chr;
function replaceWithNonBreakingSpace( index, data ) {
if ( ve.isArray( data[index] ) ) {
// Don't modify the original array, clone it first
data[index] = data[index].slice( 0 );
data[index][0] = ' ';
} else {
data[index] = ' ';
}
}
if ( data.length > 0 ) {
character = data[0];
if ( ve.isArray( character ) ? character[0] === ' ' : character === ' ' ) {
replaceWithNonBreakingSpace( 0, data );
}
}
if ( data.length > 1 ) {
character = data[data.length - 1];
if ( ve.isArray( character ) ? character[0] === ' ' : character === ' ' ) {
replaceWithNonBreakingSpace( data.length - 1, data );
}
}
if ( data.length > 2 ) {
for ( i = 1; i < data.length - 1; i++ ) {
character = data[i];
nextCharacter = data[i + 1];
if (
( ve.isArray( character ) ? character[0] === ' ' : character === ' ' ) &&
( ve.isArray( nextCharacter ) ? nextCharacter[0] === ' ' : nextCharacter === ' ' )
) {
replaceWithNonBreakingSpace( i + 1, data );
i++;
}
}
}
function openAnnotations( annotations ) {
var out = '',
annotation, i, arr;
arr = annotations.get();
for ( i = 0; i < arr.length; i++ ) {
annotation = arr[i];
out += typeof renderers[annotation.type].open === 'function' ?
renderers[annotation.type].open( annotation.data ) :
renderers[annotation.type].open;
annotationStack.push( annotation );
}
return out;
}
function closeAnnotations( annotations ) {
var out = '',
annotation, i, arr;
arr = annotations.get();
for ( i = 0; i < arr.length; i++ ) {
annotation = arr[i];
out += typeof renderers[annotation.type].close === 'function' ?
renderers[annotation.type].close( annotation.data ) :
renderers[annotation.type].close;
annotationStack.remove( annotation );
}
return out;
}
for ( i = 0; i < data.length; i++ ) {
right = data[i];
leftPlain = typeof left === 'string';
rightPlain = typeof right === 'string';
if ( !leftPlain && rightPlain ) {
// [formatted][plain]
// Close all open annotations, in reverse order
out += closeAnnotations( annotationStack.reversed() );
} else if ( leftPlain && !rightPlain ) {
// [plain][formatted]
out += openAnnotations( right[1] );
} else if ( !leftPlain && !rightPlain ) {
// [formatted][formatted]
open = new ve.AnnotationSet();
close = new ve.AnnotationSet();
// Go through annotationStack from bottom to top (left to right), and
// close all annotations starting at the first one that's in left[1] but
// not in right[1]. Then reopen the ones that are in right[1].
startedClosing = false;
arr = annotationStack.get();
for ( j = 0; j < arr.length; j++ ) {
annotation = arr[j];
if (
!startedClosing &&
left[1].contains( annotation ) &&
!right[1].contains( annotation )
) {
startedClosing = true;
}
if ( startedClosing ) {
// Because we're processing these in reverse order, we need
// to put these in close in reverse order
close.add( annotation, 0 );
if ( right[1].contains( annotation ) ) {
// open needs to be reversed with respect to close
open.push( annotation );
}
}
}
// Open all annotations that are in right but not in left
open.addSet( right[1].diffWith( left[1] ) );
out += closeAnnotations( close );
out += openAnnotations( open );
}
chr = rightPlain ? right : right[0];
out += chr in htmlChars ? htmlChars[chr] : chr;
left = right;
}
// Close all remaining open annotations
out += closeAnnotations( annotationStack.reversed() );
return out;
};
/* Registration */
ve.ce.nodeFactory.register( 'text', ve.ce.TextNode );