mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +00:00
7ea475ebcf
Ground-up rewrite of the data model. Putting this in the ve2 directory for now so we still have the old code floating around. Main changes so far in this rewrite: * Renamed hasChildren() to canHaveChildren() * Added canHaveGrandchildren() * Added a new node type TwigNode that can have children but not grandchildren (so all of its children must be LeafNodes) * Implemented push/pop/shift/unshift as wrappers around splice() * Renamed getElementType() to getType(). Nodes now take a string as a type, and the element stuff is gone and won't be back * Removed clearRoot(), replaced it with setRoot( this ) where needed Change-Id: I23f3bb1b4a2473575e5446e87fdf17af107bacf6
127 lines
2.7 KiB
JavaScript
127 lines
2.7 KiB
JavaScript
/**
|
|
* Creates an ve.Node object.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @constructor
|
|
* @extends {ve.EventEmitter}
|
|
* @param {String} type Symbolic name of node type
|
|
*/
|
|
ve.Node = function( type ) {
|
|
// Inheritance
|
|
ve.EventEmitter.call( this );
|
|
|
|
// Properties
|
|
this.type = type;
|
|
this.parent = null;
|
|
this.root = this;
|
|
|
|
// Convenience function for emitting update events
|
|
// Has this bound to the closure scope, so can be passed as a callback
|
|
var _this = this;
|
|
this.emitUpdate = function() {
|
|
_this.emit( 'update' );
|
|
};
|
|
};
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Gets the symbolic node type name.
|
|
*
|
|
* @method
|
|
* @returns {String} Symbolic name of element type
|
|
*/
|
|
ve.Node.prototype.getType = function() {
|
|
return this.type;
|
|
};
|
|
|
|
/**
|
|
* Checks if this node can have child nodes.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {Boolean} Whether this node can have children
|
|
*/
|
|
ve.Node.prototype.canHaveChildren = function() {
|
|
throw 've.Node.canHaveChildren not implemented in this subclass:' + this.constructor;
|
|
};
|
|
|
|
/**
|
|
* Checks if this node can have child nodes that can have child nodes.
|
|
*
|
|
* If this function returns false, only nodes that can't have children can be attached to this node.
|
|
* If canHaveChildren() returns false, this method must also return false.
|
|
*
|
|
* @method
|
|
* @abstract
|
|
* @returns {Boolean} Whether this node can have grandchildren
|
|
*/
|
|
ve.Node.prototype.canHaveGrandchildren = function() {
|
|
throw 've.Node.canHaveGrandchildren not implemented in this subclass:' + this.constructor;
|
|
};
|
|
|
|
/**
|
|
* Gets a reference to this node's parent.
|
|
*
|
|
* @method
|
|
* @returns {ve.Node} Reference to this node's parent
|
|
*/
|
|
ve.Node.prototype.getParent = function() {
|
|
return this.parent;
|
|
};
|
|
|
|
/**
|
|
* Gets the root node in the tree this node is currently attached to.
|
|
*
|
|
* @method
|
|
* @returns {ve.Node} Root node
|
|
*/
|
|
ve.Node.prototype.getRoot = function() {
|
|
return this.root;
|
|
};
|
|
|
|
/**
|
|
* Sets the root node to this and all of its children.
|
|
*
|
|
* This method is overridden by nodes with children.
|
|
*
|
|
* @method
|
|
* @param {ve.Node} root Node to use as root
|
|
*/
|
|
ve.Node.prototype.setRoot = function( root ) {
|
|
// TODO events?
|
|
this.root = root;
|
|
};
|
|
|
|
/**
|
|
* Attaches this node to another as a child.
|
|
*
|
|
* @method
|
|
* @param {ve.Node} parent Node to attach to
|
|
* @emits attach (parent)
|
|
*/
|
|
ve.Node.prototype.attach = function( parent ) {
|
|
this.emit( 'beforeAttach', parent );
|
|
this.parent = parent;
|
|
this.setRoot( parent.getRoot() );
|
|
this.emit( 'afterAttach', parent );
|
|
};
|
|
|
|
/**
|
|
* Detaches this node from its parent.
|
|
*
|
|
* @method
|
|
* @emits detach
|
|
*/
|
|
ve.Node.prototype.detach = function() {
|
|
this.emit( 'beforeDetach' );
|
|
this.parent = null;
|
|
this.setRoot( this );
|
|
this.emit( 'afterDetach' );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.extendClass( ve.Node, ve.EventEmitter );
|