mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-29 08:34:54 +00:00
2eb0d2a6b2
This changes the annotation API to be the same as the node API, sans a few boolean flags that don't apply. The APIs were different, but there was really no good reason why, so this makes things simpler for API users. It also means we'll be able to factor a bunch of things out because they're now duplicated between nodes, meta items and annotations. Linear model annotations are now objects with 'type' and 'attributes' properties (rather than 'name' and 'data'), for consistency with elements. They now also contain html/0/* attributes for HTML attribute preservation, which obsoletes the htmlTagName and htmlAttributes properties. dm.Annotation subclasses take a reference to such an object and implement conversion using .static.toDataElement and .static.toDomElements just like nodes do. The custom .getHash() functions are no longer necessary because of the way HTML attribute preservation was reimplemented. CE rendering has been moved out of dm.Annotation (it never made sense to have CE rendering functions in DM classes, this was bothering me) and into separate ce.Annotation subclasses. These are very similar to CE nodes in that they have a this.$ generated based on something in the DM; the main difference is that nodes listen to events and update themselves, whereas annotations are static and are simply destroyed and rebuilt when they change. This change also adds whitelisted HTML attribute rendering for annotations, as well as class="ve-ce-FooAnnotation" attributes. Now that annotation classes produce real DOM nodes rather than weird objects describing HTML tags, we can't generate HTML as a string in ce.ContentBranchNode anymore. getRenderedContents() has been rewritten to be much more similar to the way the converter renders annotations; in fact, significant parts of it were copied from the converter, so that should be factored out in the future. This change actually fixes an annotation rendering discrepancy between ce.ContentBranchNode and dm.Converter; see the diff of ve.ce.ContentBranchNode.test.js. ve.ce.MWEntityNode.js: * Remove stray property ve.dm.MWExternalLinkAnnotation.js: * Store 'rel' attribute ve.dm.TextStyleAnnotation.js: * Put all the conversion logic in the abstract base class ve.dm.Converter.js: * Also feed annotations through getDomElementsFromDataElement() and createDataElement() ve.dm.Node.js: * Fix undocumented property ve.ce.ContentBranchNode.test.js: * Add descriptive messages for each test case * Compare DOM trees, not HTML strings * Compare without all the class="ve-ce-WhateverAnnotation" clutter ve.ui.LinkInspector.js: * Replace direct .getHash() calls (evil!) with ve.getHash() Bug: 46464 Bug: 44808 Change-Id: I31991488579b8cce6d98ed8b29b486ba5ec38cdc
106 lines
2.9 KiB
JavaScript
106 lines
2.9 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable Annotation class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Generic ContentEditable annotation.
|
|
*
|
|
* This is an abstract class, annotations should extend this and call this constructor from their
|
|
* constructor. You should not instantiate this class directly.
|
|
*
|
|
* Subclasses of ve.dm.Annotation should have a corresponding subclass here that controls rendering.
|
|
*
|
|
* @class
|
|
* @constructor
|
|
* @param {ve.dm.Annotation} model Model to observe
|
|
* @param {jQuery} [$element] Element to use as a container
|
|
*/
|
|
ve.ce.Annotation = function VeCeAnnotation( model, $element ) {
|
|
// Properties
|
|
this.model = model;
|
|
this.$ = $element || $( '<span>' );
|
|
this.parent = null;
|
|
this.live = false;
|
|
|
|
// Initialization
|
|
this.$.data( 'annotation', this );
|
|
ve.setDomAttributes(
|
|
this.$[0],
|
|
this.model.getAttributes( 'html/0/' ),
|
|
this.constructor.static.domAttributeWhitelist
|
|
);
|
|
};
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event live
|
|
*/
|
|
|
|
/* Static Members */
|
|
|
|
// TODO create a single base class for ce.Node and ce.Annotation
|
|
|
|
ve.ce.Annotation.static = {};
|
|
|
|
/**
|
|
* Allowed attributes for DOM elements.
|
|
*
|
|
* This list includes attributes that are generally safe to include in HTML loaded from a
|
|
* foreign source and displaying it inside the browser. It doesn't include any event attributes,
|
|
* for instance, which would allow arbitrary JavaScript execution. This alone is not enough to
|
|
* make HTML safe to display, but it helps.
|
|
*
|
|
* TODO: Rather than use a single global list, set these on a per-annotation basis to something that makes
|
|
* sense for that annotation in particular.
|
|
*
|
|
* @static
|
|
* @property static.domAttributeWhitelist
|
|
* @inheritable
|
|
*/
|
|
ve.ce.Annotation.static.domAttributeWhitelist = [
|
|
'abbr', 'about', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellpadding', 'cellspacing',
|
|
'char', 'charoff', 'cite', 'class', 'clear', 'color', 'colspan', 'datatype', 'datetime',
|
|
'dir', 'face', 'frame', 'headers', 'height', 'href', 'id', 'itemid', 'itemprop', 'itemref',
|
|
'itemscope', 'itemtype', 'lang', 'noshade', 'nowrap', 'property', 'rbspan', 'rel',
|
|
'resource', 'rev', 'rowspan', 'rules', 'scope', 'size', 'span', 'src', 'start', 'style',
|
|
'summary', 'title', 'type', 'typeof', 'valign', 'value', 'width'
|
|
];
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get the model this CE annotation observes.
|
|
*
|
|
* @method
|
|
* @returns {ve.ce.Annotation} Model
|
|
*/
|
|
ve.ce.Annotation.prototype.getModel = function () {
|
|
return this.model;
|
|
};
|
|
|
|
/**
|
|
* Check if the annotation is attached to the live DOM.
|
|
*
|
|
* @method
|
|
* @returns {boolean} Annotation is attached to the live DOM
|
|
*/
|
|
ve.ce.Annotation.prototype.isLive = function () {
|
|
return this.live;
|
|
};
|
|
|
|
/**
|
|
* Set live state.
|
|
*
|
|
* @method
|
|
* @param {boolean} live The annotation has been attached to the live DOM (use false on detach)
|
|
* @emits live
|
|
*/
|
|
ve.ce.Annotation.prototype.setLive = function ( live ) {
|
|
this.live = live;
|
|
this.emit( 'live' );
|
|
};
|