mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 04:06:51 +00:00
b11bbed7a6
See CODING.md for how to run it. Mistakes fixed: * Warning: Unknown type function -> Function * Warning: Unknown type DOMElement -> HTMLElement * Warning: Unknown type DOM Node -> HTMLElement * Warning: Unknown type Integer -> Mixed * Warning: Unknown type Command -> ve.Command * Warning: Unknown type any -> number * Warning: Unknown type ve.Transaction -> ve.dm.Transaction * Warning: Unknown type ve.dm.AnnotationSet -> ve.AnnotationSet * Warning: Unknown type false -> boolean * Warning: Unknown type ve.dm.AlienNode ve.dm doesn't have a generic AlienNode like ve.ce -> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode * Warning: Unknown type ve.ve.Surface -> ve.ce.Surface * ve.example.lookupNode: -> Last @param should be @return * ve.dm.Transaction.prototype.pushReplace: -> @param {Array] should be @param {Array} * Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member -> (removed) * Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member -> (removed) Differences fixed: * Variadic arguments are like @param {Type...} [name] instead of @param {Type} [name...] * Convert all file headers from /** to /*! because JSDuck tries to parse all /** blocks and fails to parse with all sorts of errors for "Global property", "Unnamed property", and "Duplicate property". Find: \/\*\*([^@]+)(@copyright) Replace: /*!$1$2 * Indented blocks are considered code examples. A few methods had documentation with numbered lists that were indented, which have now been updated to not be intended. * The free-form text descriptions are parsed with Markdown, which requires lists to be separated from paragraphs by an empty line. And we should use `backticks` instead of {braces} for inline code in text paragraphs. * Doc blocks for classes and their constructor have to be in the correct order (@constructor, @param, @return must be before @class, @abstract, @extends etc.) * `@extends Class` must not have Class {wrapped} * @throws must start with a {Type} * @example means something else. It is used for an inline demo iframe, not code block. For that simply indent with spaces. * @member means something else. Non-function properties are marked with @property, not @member. * To create a link to a class or member, in most cases the name is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux, where a hash stands for "instance member", so Foo.bar#quux, links to Foo.bar.prototype.quux (the is not supported, as "prototype" is considered an implementation detail, it only indexes class name and method name). If the magic linker doesn't work for some case, the verbose syntax is {@link #target label}. * @property can't have sub-properties (nested @param and @return values are supported, only @static @property can't be nested). We only have one case of this, which can be worked around by moving those in a new virtual class. The code is unaltered (only moved down so that it isn't with the scope of the main @class block). ve.dm.TransactionProcessor.processors. New: * @mixins: Classes mixed into the current class. * @event: Events that can be emitted by a class. These are also inherited by subclasses. (+ @param, @return and @preventable). So ve.Node#event-attach is inherited to ve.dm.BreakNode, just like @method is. * @singleton: Plain objects such as ve, ve.dm, ve.ce were missing documentation causing a tree error. Documented those as a JSDuck singleton, which they but just weren't documented yet. NB: Members of @singleton don't need @static (if present, triggers a compiler warning). * @chainable: Shorthand for "@return this". We were using "@return {classname}" which is ambiguous (returns the same instance or another instance?), @chainable is specifically for "@return this". Creates proper labels in the generated HTML pages. Removed: * @mixin: (not to be confused with @mixins). Not supported by JSDuck. Every class is standalone anyway. Where needed marked them @class + @abstract instead. Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
266 lines
6.2 KiB
JavaScript
266 lines
6.2 KiB
JavaScript
/*!
|
|
* VisualEditor content editable Node class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Generic ContentEditable node.
|
|
*
|
|
* @abstract
|
|
* @extends ve.Node
|
|
*
|
|
* @constructor
|
|
* @param {string} type Symbolic name of node type
|
|
* @param {ve.dm.Node} model Model to observe
|
|
* @param {jQuery} [$element] Element to use as a container
|
|
*/
|
|
ve.ce.Node = function VeCeNode( type, model, $element ) {
|
|
// Parent constructor
|
|
ve.Node.call( this, type );
|
|
|
|
// Properties
|
|
this.model = model;
|
|
this.$ = $element || $( '<div>' );
|
|
this.parent = null;
|
|
this.live = false;
|
|
|
|
// Initialization
|
|
this.$.data( 'node', this );
|
|
ve.setDomAttributes(
|
|
this.$[0],
|
|
this.model.getAttributes( 'html/' ),
|
|
this.constructor.static.domAttributeWhitelist
|
|
);
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ce.Node, ve.Node );
|
|
|
|
/* Static Memebers */
|
|
|
|
/**
|
|
* @static
|
|
* @property
|
|
* @inheritable
|
|
*/
|
|
ve.ce.Node.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-node basis to something that makes
|
|
* sense for that node in particular.
|
|
*
|
|
* @static
|
|
* @property static.domAttributeWhitelist
|
|
* @inheritable
|
|
*/
|
|
ve.ce.Node.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'
|
|
];
|
|
|
|
/**
|
|
* Template for shield elements.
|
|
*
|
|
* Uses data URI to inject a 1x1 transparent PNG image into the DOM.
|
|
*
|
|
* @static
|
|
* @property static.$shieldTemplate
|
|
* @inheritable
|
|
*/
|
|
// Using transparent png instead of gif because IE 10 renders gif as solid red when used as img src.
|
|
ve.ce.Node.static.$shieldTemplate = $(
|
|
'<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAFElEQVR4XgXAAQ0AAABAMP1L30IDCPwC/o5WcS4AAAAASUVORK5CYII=" ' +
|
|
'class="ve-ce-node-shield">'
|
|
);
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Gets a list of allowed child node types.
|
|
*
|
|
* This method passes through to the model.
|
|
*
|
|
* @method
|
|
* @returns {String[]|null} List of node types allowed as children or null if any type is allowed
|
|
*/
|
|
ve.ce.Node.prototype.getChildNodeTypes = function () {
|
|
return this.model.getChildNodeTypes();
|
|
};
|
|
|
|
/**
|
|
* Gets a list of allowed parent node types.
|
|
*
|
|
* This method passes through to the model.
|
|
*
|
|
* @method
|
|
* @returns {String[]|null} List of node types allowed as parents or null if any type is allowed
|
|
*/
|
|
ve.ce.Node.prototype.getParentNodeTypes = function () {
|
|
return this.model.getParentNodeTypes();
|
|
};
|
|
|
|
/**
|
|
* Checks if model is for a node that can have children.
|
|
*
|
|
* This method passes through to the model.
|
|
*
|
|
* @method
|
|
* @returns {boolean} Model node can have children
|
|
*/
|
|
ve.ce.Node.prototype.canHaveChildren = function () {
|
|
return this.model.canHaveChildren();
|
|
};
|
|
|
|
/**
|
|
* Checks if model is for a node that can have grandchildren.
|
|
*
|
|
* This method passes through to the model.
|
|
*
|
|
* @method
|
|
* @returns {boolean} Model node can have grandchildren
|
|
*/
|
|
ve.ce.Node.prototype.canHaveGrandchildren = function () {
|
|
return this.model.canHaveGrandchildren();
|
|
};
|
|
|
|
/**
|
|
* Checks if model is for a wrapped element.
|
|
*
|
|
* This method passes through to the model.
|
|
*
|
|
* @method
|
|
* @returns {boolean} Model node is a wrapped element
|
|
*/
|
|
ve.ce.Node.prototype.isWrapped = function () {
|
|
return this.model.isWrapped();
|
|
};
|
|
|
|
/**
|
|
* Checks if this node can contain content.
|
|
*
|
|
* @method
|
|
* @returns {boolean} Node can contain content
|
|
*/
|
|
ve.ce.Node.prototype.canContainContent = function () {
|
|
return this.model.canContainContent();
|
|
};
|
|
|
|
/**
|
|
* Checks if this node is content.
|
|
*
|
|
* @method
|
|
* @returns {boolean} Node is content
|
|
*/
|
|
ve.ce.Node.prototype.isContent = function () {
|
|
return this.model.isContent();
|
|
};
|
|
|
|
/**
|
|
* Checks if this node can have a slug before it
|
|
*
|
|
* @static
|
|
* @method
|
|
* @returns {boolean} Whether the node can have a slug before it
|
|
*/
|
|
ve.ce.Node.prototype.canHaveSlugBefore = function () {
|
|
return !this.canContainContent() && this.getParentNodeTypes() === null && this.type !== 'text';
|
|
};
|
|
|
|
/**
|
|
* Checks if this node can have a slug after it
|
|
*
|
|
* @static
|
|
* @method
|
|
* @returns {boolean} Whether the node can have a slug after it
|
|
*/
|
|
ve.ce.Node.prototype.canHaveSlugAfter = ve.ce.Node.prototype.canHaveSlugBefore;
|
|
|
|
/**
|
|
* Gets model length.
|
|
*
|
|
* This method passes through to the model.
|
|
*
|
|
* @method
|
|
* @returns {number} Model length
|
|
*/
|
|
ve.ce.Node.prototype.getLength = function () {
|
|
return this.model.getLength();
|
|
};
|
|
|
|
/**
|
|
* Gets model outer length.
|
|
*
|
|
* This method passes through to the model.
|
|
*
|
|
* @method
|
|
* @returns {number} Model outer length
|
|
*/
|
|
ve.ce.Node.prototype.getOuterLength = function () {
|
|
return this.model.getOuterLength();
|
|
};
|
|
|
|
/**
|
|
* Checks if this node can be split.
|
|
*
|
|
* @method
|
|
* @returns {boolean} Node can be split
|
|
*/
|
|
ve.ce.Node.prototype.canBeSplit = function () {
|
|
return ve.ce.nodeFactory.canNodeBeSplit( this.type );
|
|
};
|
|
|
|
/**
|
|
* Gets a reference to the model this node observes.
|
|
*
|
|
* @method
|
|
* @returns {ve.dm.Node} Reference to the model this node observes
|
|
*/
|
|
ve.ce.Node.prototype.getModel = function () {
|
|
return this.model;
|
|
};
|
|
|
|
ve.ce.Node.getSplitableNode = function ( node ) {
|
|
var splitableNode = null;
|
|
|
|
ve.Node.traverseUpstream( node, function ( node ) {
|
|
if ( node.canBeSplit() ) {
|
|
splitableNode = node;
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
} );
|
|
|
|
return splitableNode;
|
|
};
|
|
|
|
/**
|
|
* @method
|
|
* @returns {boolean} Node is attached to the live DOM
|
|
*/
|
|
ve.ce.Node.prototype.isLive = function () {
|
|
return this.live;
|
|
};
|
|
|
|
/**
|
|
* @method
|
|
*/
|
|
ve.ce.Node.prototype.setLive = function ( live ) {
|
|
this.live = live;
|
|
this.emit( 'live' );
|
|
};
|