mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-29 16:44:51 +00:00
8d33a3de0d
* Made method descriptions imperative: "Do this" rather than "Does this" * Changed use of "this object" to "the object" in method documentation * Added missing documentation * Fixed incorrect documentation * Fixed incorrect debug method names (as in those VeDmClassName tags we add to functions so they make sense when dumped into in the console) * Normalized use of package names throughout * Normalized class descriptions * Removed incorrect @abstract tags * Added missing @method tags * Lots of other minor cleanup Change-Id: I4ea66a2dd107613e2ea3a5f56ff54d675d72957e
91 lines
1.8 KiB
JavaScript
91 lines
1.8 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable DocumentNode class.
|
|
*
|
|
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable document node.
|
|
*
|
|
* @class
|
|
* @extends ve.ce.BranchNode
|
|
* @constructor
|
|
* @param {ve.dm.DocumentNode} model Model to observe
|
|
*/
|
|
ve.ce.DocumentNode = function VeCeDocumentNode( model, surface ) {
|
|
// Parent constructor
|
|
ve.ce.BranchNode.call( this, 'document', model );
|
|
|
|
// Properties
|
|
this.surface = surface;
|
|
|
|
// DOM Changes
|
|
this.$.addClass( 've-ce-documentNode' );
|
|
this.$.attr( 'contentEditable', 'true' );
|
|
this.$.attr( 'spellcheck', 'true' );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ce.DocumentNode, ve.ce.BranchNode );
|
|
|
|
/* Static Properties */
|
|
|
|
/**
|
|
* Node rules.
|
|
*
|
|
* @see ve.ce.NodeFactory
|
|
* @static
|
|
* @property
|
|
*/
|
|
ve.ce.DocumentNode.rules = {
|
|
'canBeSplit': false
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Get the outer length.
|
|
*
|
|
* For a document node is the same as the inner length, which is why we override it here.
|
|
*
|
|
* @method
|
|
* @returns {number} Length of the entire node
|
|
*/
|
|
ve.ce.DocumentNode.prototype.getOuterLength = function () {
|
|
return this.length;
|
|
};
|
|
|
|
/**
|
|
* Get the surface the document is attached to.
|
|
*
|
|
* @method
|
|
* @returns {ve.ce.Surface} Surface the document is attached to
|
|
*/
|
|
ve.ce.DocumentNode.prototype.getSurface = function () {
|
|
return this.surface;
|
|
};
|
|
|
|
/**
|
|
* Disable editing.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.DocumentNode.prototype.disable = function () {
|
|
this.$.css( 'opacity', 0.5 ).attr( 'contentEditable', 'false' );
|
|
};
|
|
|
|
/**
|
|
* Enable editing.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.DocumentNode.prototype.enable = function () {
|
|
this.$.css( 'opacity', 1 ).attr( 'contentEditable', 'true' );
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.ce.nodeFactory.register( 'document', ve.ce.DocumentNode );
|