2012-04-30 23:58:41 +00:00
|
|
|
/**
|
|
|
|
* Generic ContentEditable node.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-04-30 23:58:41 +00:00
|
|
|
* @class
|
|
|
|
* @abstract
|
|
|
|
* @constructor
|
|
|
|
* @extends {ve.Node}
|
2012-05-05 00:50:54 +00:00
|
|
|
* @param {String} type Symbolic name of node type
|
2012-04-30 23:58:41 +00:00
|
|
|
* @param {ve.dm.Node} model Model to observe
|
2012-05-01 02:38:42 +00:00
|
|
|
* @param {jQuery} [$element] Element to use as a container
|
2012-04-30 23:58:41 +00:00
|
|
|
*/
|
2012-05-05 00:50:54 +00:00
|
|
|
ve.ce.Node = function( type, model, $element ) {
|
2012-04-30 23:58:41 +00:00
|
|
|
// Inheritance
|
2012-05-05 00:50:54 +00:00
|
|
|
ve.Node.call( this, type );
|
2012-04-30 23:58:41 +00:00
|
|
|
|
|
|
|
// Properties
|
|
|
|
this.model = model;
|
2012-05-01 02:38:42 +00:00
|
|
|
this.$ = $element || $( '<div></div>' );
|
2012-04-30 23:58:41 +00:00
|
|
|
this.parent = null;
|
2012-05-10 05:43:46 +00:00
|
|
|
|
|
|
|
this.$.data( 'node', this );
|
2012-04-30 23:58:41 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Methods */
|
|
|
|
|
2012-05-24 20:12:45 +00:00
|
|
|
/**
|
|
|
|
* Gets a list of allowed child node types.
|
|
|
|
*
|
|
|
|
* This method passes through to the model.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @returns {String[]|null} List of node types allowed as children or null if any type is allowed
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.getChildNodeTypes = function() {
|
|
|
|
return this.model.getChildNodeTypes();
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets a list of allowed parent node types.
|
|
|
|
*
|
|
|
|
* This method passes through to the model.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @returns {String[]|null} List of node types allowed as parents or null if any type is allowed
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.getParentNodeTypes = function() {
|
|
|
|
return this.model.getParentNodeTypes();
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks if model is for a node that can have children.
|
|
|
|
*
|
|
|
|
* This method passes through to the model.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @returns {Boolean} Model node can have children
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.canHaveChildren = function() {
|
|
|
|
return this.model.canHaveChildren();
|
|
|
|
};
|
|
|
|
|
2012-05-05 00:50:54 +00:00
|
|
|
/**
|
2012-05-10 04:11:09 +00:00
|
|
|
* Checks if model is for a node that can have children.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* This method passes through to the model.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-05 00:50:54 +00:00
|
|
|
* @method
|
2012-05-10 04:11:09 +00:00
|
|
|
* @returns {Boolean} Model node can have children
|
2012-05-05 00:50:54 +00:00
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.canHaveChildren = function() {
|
2012-05-10 04:11:09 +00:00
|
|
|
return this.model.canHaveChildren();
|
2012-05-05 00:50:54 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2012-05-10 04:11:09 +00:00
|
|
|
* Checks if model is for a node that can have grandchildren.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* This method passes through to the model.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-05 00:50:54 +00:00
|
|
|
* @method
|
2012-05-10 04:11:09 +00:00
|
|
|
* @returns {Boolean} Model node can have grandchildren
|
2012-05-05 00:50:54 +00:00
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.canHaveGrandchildren = function() {
|
2012-05-10 04:11:09 +00:00
|
|
|
return this.model.canHaveGrandchildren();
|
2012-05-05 00:50:54 +00:00
|
|
|
};
|
|
|
|
|
2012-04-30 23:58:41 +00:00
|
|
|
/**
|
2012-05-10 04:11:09 +00:00
|
|
|
* Checks if model is for a wrapped element.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* This method passes through to the model.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-04-30 23:58:41 +00:00
|
|
|
* @method
|
2012-05-10 04:11:09 +00:00
|
|
|
* @returns {Boolean} Model node is a wrapped element
|
2012-04-30 23:58:41 +00:00
|
|
|
*/
|
2012-05-10 04:11:09 +00:00
|
|
|
ve.ce.Node.prototype.isWrapped = function() {
|
|
|
|
return this.model.isWrapped();
|
|
|
|
};
|
|
|
|
|
2012-05-22 00:39:03 +00:00
|
|
|
/**
|
|
|
|
* Checks if this node can contain content.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @returns {Boolean} Node can contain content
|
|
|
|
*/
|
2012-05-24 20:12:45 +00:00
|
|
|
ve.ce.Node.prototype.canContainContent = function() {
|
2012-05-22 00:39:03 +00:00
|
|
|
return this.model.canContainContent();
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks if this node is content.
|
|
|
|
*
|
|
|
|
* @method
|
|
|
|
* @returns {Boolean} Node is content
|
|
|
|
*/
|
2012-05-24 20:12:45 +00:00
|
|
|
ve.ce.Node.prototype.isContent = function() {
|
2012-05-22 00:39:03 +00:00
|
|
|
return this.model.isContent();
|
|
|
|
};
|
|
|
|
|
2012-05-24 21:01:17 +00:00
|
|
|
/**
|
|
|
|
* Checks if this node can have a slug before or after it.
|
|
|
|
*
|
|
|
|
* @static
|
|
|
|
* @method
|
|
|
|
* @returns {Boolean} Node can have a slug
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.canHaveSlug = function() {
|
|
|
|
return !this.canContainContent() && this.getParentNodeTypes() === null && this.type !== 'text';
|
|
|
|
};
|
|
|
|
|
2012-05-10 04:11:09 +00:00
|
|
|
/**
|
|
|
|
* Gets model length.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* This method passes through to the model.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* @method
|
|
|
|
* @returns {Integer} Model length
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.getLength = function() {
|
|
|
|
return this.model.getLength();
|
2012-04-30 23:58:41 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
2012-05-10 04:11:09 +00:00
|
|
|
* Gets model outer length.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* This method passes through to the model.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-04-30 23:58:41 +00:00
|
|
|
* @method
|
2012-05-10 04:11:09 +00:00
|
|
|
* @returns {Integer} Model outer length
|
2012-04-30 23:58:41 +00:00
|
|
|
*/
|
2012-05-10 04:11:09 +00:00
|
|
|
ve.ce.Node.prototype.getOuterLength = function() {
|
|
|
|
return this.model.getOuterLength();
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Checks if this node can be split.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* @method
|
|
|
|
* @returns {Boolean} Node can be split
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.canBeSplit = function() {
|
2012-05-31 22:20:58 +00:00
|
|
|
return ve.ce.nodeFactory.canNodeBeSplit( this.type );
|
2012-05-10 04:11:09 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets a reference to the model this node observes.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-05-10 04:11:09 +00:00
|
|
|
* @method
|
|
|
|
* @returns {ve.dm.Node} Reference to the model this node observes
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.getModel = function() {
|
|
|
|
return this.model;
|
2012-04-30 23:58:41 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Attaches node as a child to another node.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-04-30 23:58:41 +00:00
|
|
|
* @method
|
|
|
|
* @param {ve.ce.Node} parent Node to attach to
|
|
|
|
* @emits attach (parent)
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.attach = function( parent ) {
|
|
|
|
this.parent = parent;
|
|
|
|
this.emit( 'attach', parent );
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Detaches node from it's parent.
|
2012-05-14 22:05:09 +00:00
|
|
|
*
|
2012-04-30 23:58:41 +00:00
|
|
|
* @method
|
|
|
|
* @emits detach (parent)
|
|
|
|
*/
|
|
|
|
ve.ce.Node.prototype.detach = function() {
|
|
|
|
var parent = this.parent;
|
|
|
|
this.parent = null;
|
|
|
|
this.emit( 'detach', parent );
|
|
|
|
};
|
|
|
|
|
|
|
|
/* Inheritance */
|
|
|
|
|
|
|
|
ve.extendClass( ve.ce.Node, ve.Node );
|