mediawiki-extensions-VisualEditor/modules/ve/ce/nodes/ve.ce.DocumentNode.js

/**
 * VisualEditor content editable DocumentNode class.
 *
 * @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * ContentEditable node for a document.
 *
 * @class
 * @constructor
 * @extends {ve.ce.BranchNode}
 * @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 Members */

/**
 * Node rules.
 *
 * @see ve.ce.NodeFactory
 * @static
 * @member
 */
ve.ce.DocumentNode.rules = {
	'canBeSplit': false
};

/* Methods */

/**
 * Gets the outer length, which for a document node is the same as the inner length.
 *
 * @method
 * @returns {Number} Length of the entire node
 */
ve.ce.DocumentNode.prototype.getOuterLength = function () {
	return this.length;
};

/**
 * Gets the surface this document is attached to.
 *
 * @method
 * @returns {ve.ve.Surface} Surface this document is attached to
 */
ve.ce.DocumentNode.prototype.getSurface = function () {
	return this.surface;
};

/**
 * Disables editing.
 *
 * @method
 */
ve.ce.DocumentNode.prototype.disable = function () {
	this.$.css( 'opacity', 0.5 ).attr( 'contentEditable', 'false' );
};

/**
 * Disables editing.
 *
 * @method
 */
ve.ce.DocumentNode.prototype.enable = function () {
	this.$.css( 'opacity', 1 ).attr( 'contentEditable', 'true' );
};

/* Registration */

ve.ce.nodeFactory.register( 'document', ve.ce.DocumentNode );