mediawiki-extensions-Visual.../modules/ve/ce/nodes/ve.ce.DocumentNode.js
Trevor Parscal c2defc9783 ve.Element refactor
Objectives:

* Move ve.ui.Element to ve.Element
* Make CE nodes inherit from ve.Element

Changes:

ve.ui.Element.js, ve.Element.js
* Move and rename
* Move ve.ui.get$$ to ve.Element.static.get$$
* Add static getDocument and getWindow methods
* Add instance getElementDocument and getElementWindow methods
* Add getTagName method, which by default reads the static tagName property, but when overridden can return a tag name based on other factors

*.php
* Updated file link

ve.ce.*Annotation.js, ve.ce.*Node.js, ve.ce.View.js, ve.ce.Document
* Added config options pass through
* Replaced passing elements through constructor with defining static tag names
* Added getTagName overrides where needed that derive tag name from model
* Refactore dom wrapper methods, now consistently using getTagName

ve.ce.Surface.js
* Removed static initialization (not needed)

ve.dm.Model.js, ve.ui.Window.js
* Added missing docs

ve.ui.GroupElement.js, ve.ui.Layout.js, ve.ui.Widget.js,
* Updated class name for elements

ve.ui.Frame.js, ve.ui.LookupInputWidget.js
* Updated location of get$$

ve.ui.js
* Move get$$ to ve.Element

ve.js
* Add auto-init of static properties to mixinClass

Change-Id: I39ae14966456903728e4d9e53f806ddce9ca2b70
2013-05-14 19:47:32 +00:00

83 lines
1.8 KiB
JavaScript

/*!
* VisualEditor ContentEditable DocumentNode class.
*
* @copyright 2011-2013 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
* @param {ve.Surface} surface Surface document is part of
* @param {Object} [config] Config options
*/
ve.ce.DocumentNode = function VeCeDocumentNode( model, surface, config ) {
// Parent constructor
ve.ce.BranchNode.call( this, model, config );
// Properties
this.surface = surface;
// DOM Changes
this.$.addClass( 've-ce-documentNode' );
this.$.attr( { 'contentEditable': 'true', 'spellcheck': 'true' } );
};
/* Inheritance */
ve.inheritClass( ve.ce.DocumentNode, ve.ce.BranchNode );
/* Static Properties */
ve.ce.DocumentNode.static.name = 'document';
/* 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( ve.ce.DocumentNode );