mediawiki-extensions-Visual.../modules/ve/dm/annotations/ve.dm.LinkAnnotation.js
Trevor Parscal 280c85d8e7 Added support for passing data into annotation constructors
This resolves a TODO

* Added logic to support passing an argument into annotation constructor which is used as the data property (reusing the element argument)
* Updated documentation
* Simplified instantiation of annotations

Change-Id: I142b8fa3883bf70c896a2a568088d833814ef2dc
2013-01-28 11:01:52 -08:00

72 lines
1.6 KiB
JavaScript

/*!
* VisualEditor DataModel LinkAnnotation class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* DataModel link annotation.
*
* Represents `<a>` tags that don't have a specific type.
*
* @class
* @extends ve.dm.Annotation
* @constructor
* @param {HTMLElement|Object} element
*/
ve.dm.LinkAnnotation = function VeDmLinkAnnotation( element ) {
// Parent constructor
ve.dm.Annotation.call( this, element );
};
/* Inheritance */
ve.inheritClass( ve.dm.LinkAnnotation, ve.dm.Annotation );
/* Static Properties */
/**
* @static
* @property static.name
* @inheritdoc
*/
ve.dm.LinkAnnotation.static.name = 'link';
/**
* @static
* @property static.matchTagNames
* @inheritdoc
*/
ve.dm.LinkAnnotation.static.matchTagNames = ['a'];
/* Methods */
/**
* Get annotation data, especially the href of the link.
*
* @method
* @param {HTMLElement} element
* @returns {Object} Annotation data, containing href property
*/
ve.dm.LinkAnnotation.prototype.getAnnotationData = function( element ) {
return { 'href': element.getAttribute( 'href' ) };
};
/**
* Convert to an object with HTML element information.
*
* @method
* @returns {Object} HTML element information, including tag and attributes properties
*/
ve.dm.LinkAnnotation.prototype.toHTML = function () {
var parentResult = ve.dm.Annotation.prototype.toHTML.call( this );
parentResult.tag = 'a';
parentResult.attributes.href = this.data.href;
return parentResult;
};
/* Registration */
ve.dm.modelRegistry.register( ve.dm.LinkAnnotation );