mediawiki-extensions-Visual.../modules/ve/ce/nodes/ve.ce.ListNode.js
Trevor Parscal db9f941fa6 Rename this.$ to this.$element, and this.$$ to this.$
Objectives:
* Rename this.$ to this.$element
* Rename this.$$ to this.$
* Get rid of the need to use this.frame.$$
* Rename OO.ui.Element.get$$ to OO.ui.Element.getJQuery

Changes: (using Sublime Text regex patterns)
* Replace "get$$" with "getJQuery"
* Replace "\.(\$)([^\$a-zA-Z])" with ".$element$2"
* Replace "\.(\$\$)" with ".$"
* Replace "'$$'" with "'$'"
* Set this.$ to null in constructor of OO.ui.Window
* Set this.$ to this.frame.$ in initialize method of OO.ui.Window
* Replace "\.(frame.\$)([^\$a-zA-Z])" with ".\$$2"

Bonus:
* Use this.$() in a bunch of places where $() was erroneously used

Change-Id: If3d870124ab8d10f8223532cda95c2b2b075db94
2013-11-03 23:03:49 -08:00

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] Configuration 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 */
OO.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.$element.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 );