mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-16 10:59:56 +00:00
2fb1a11a1a
Follows-up I99acbd1699:
* "Parent method" comment
* Remove redundant slice() call to convert arguments to array,
native JavaScript methods that take array-like arguments such
as Function#apply and Array#slice are both compatible with
the Arguments objects, no need to convert it. Most invocations
already did this right but a few were recently introduced again.
* Removed silly "Document dialog." descriptions.
* Removed a few redundant "@method" tags in the near vicinity
of code I changed.
* Fixed function invocation to be either on one line or
one parameter per line. Having all arguments on one line
but the name + "(" looks confusing as it suggest there
is only 1 parameter. Same as object literals:
so:
{ foo: 1, bar }
or:
{
foo: 1,
bar: 2,
}
not:
{
foo: 1, bar: 2
}
Change-Id: I379bc2b32603bcf90aba9b4cd0112e7f027d070e
100 lines
2.3 KiB
JavaScript
100 lines
2.3 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable ListNode class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable list node.
|
|
*
|
|
* @class
|
|
* @extends ve.ce.BranchNode
|
|
* @constructor
|
|
* @param {ve.dm.ListNode} model Model to observe
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ce.ListNode = function VeCeListNode( model, config ) {
|
|
// Parent constructor
|
|
ve.ce.BranchNode.call( this, model, config );
|
|
|
|
// Events
|
|
this.model.connect( this, { 'update': 'onUpdate' } );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ce.ListNode, ve.ce.BranchNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ce.ListNode.static.name = 'list';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get the HTML tag name.
|
|
*
|
|
* Tag name is selected based on the model's style attribute.
|
|
*
|
|
* @returns {string} HTML tag name
|
|
* @throws {Error} If style is invalid
|
|
*/
|
|
ve.ce.ListNode.prototype.getTagName = function () {
|
|
var style = this.model.getAttribute( 'style' ),
|
|
types = { 'bullet': 'ul', 'number': 'ol' };
|
|
|
|
if ( !( style in types ) ) {
|
|
throw new Error( 'Invalid style' );
|
|
}
|
|
return types[style];
|
|
};
|
|
|
|
/**
|
|
* Handle model update events.
|
|
*
|
|
* If the style changed since last update the DOM wrapper will be replaced with an appropriate one.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.ListNode.prototype.onUpdate = function () {
|
|
this.updateTagName();
|
|
};
|
|
|
|
/**
|
|
* Handle splice events.
|
|
*
|
|
* This is used to solve a rendering bug in Firefox.
|
|
* @see ve.ce.BranchNode#onSplice
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.ListNode.prototype.onSplice = function () {
|
|
// Parent method
|
|
ve.ce.BranchNode.prototype.onSplice.apply( this, arguments );
|
|
|
|
// There's a bug in Firefox where numbered lists aren't renumbered after in/outdenting
|
|
// list items. Force renumbering by requesting the height, which causes a reflow
|
|
this.$.css( 'height' );
|
|
};
|
|
|
|
/**
|
|
* Check if a slug be placed after the node.
|
|
*
|
|
* @method
|
|
* @returns {boolean} A slug can be placed after the node
|
|
*/
|
|
ve.ce.ListNode.prototype.canHaveSlugAfter = function () {
|
|
if ( this.getParent().getType() === 'listItem' ) {
|
|
// Nested lists should not have slugs after them
|
|
return false;
|
|
} else {
|
|
// Parent method
|
|
return ve.ce.BranchNode.prototype.canHaveSlugAfter.call( this );
|
|
}
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.ce.nodeFactory.register( ve.ce.ListNode );
|