mediawiki-extensions-Visual.../modules/ve/ui/widgets/ve.ui.LinkTargetInputWidget.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

86 lines
2.1 KiB
JavaScript

/*!
* VisualEditor user interface LinkTargetInputWidget class.
*
* @copyright 2011-2012 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.LinkTargetInputWidget object.
*
* @class
* @constructor
* @extends ve.ui.TextInputWidget
* @param {Function} $$ jQuery for the frame the widget is in
* @param {jQuery} $overlay DOM element to add menu to
* @param {string} [name] Input name, used by HTML forms
* @param {string} [value] Input value
*/
ve.ui.LinkTargetInputWidget = function VeUiLinkTargetInputWidget( $$, $overlay, name, value ) {
// Parent constructor
ve.ui.TextInputWidget.call( this, $$, name, value );
// Properties
this.annotation = null;
// Events
this.addListenerMethod( this, 'change', 'onChange' );
// Initialization
this.$.addClass( 've-ui-linkTargetInputWidget' );
};
/* Inheritance */
ve.inheritClass( ve.ui.LinkTargetInputWidget, ve.ui.TextInputWidget );
/* Methods */
/**
* Handles change events.
*
* @method
* @param {jQuery.Event} e Event
*/
ve.ui.LinkTargetInputWidget.prototype.onChange = function ( value ) {
if ( value === '' ) {
this.annotation = null;
} else {
this.setAnnotation( new ve.dm.LinkAnnotation( { 'href': value } ) );
}
};
/**
* Sets the annotation value.
*
* The input value will automatically be updated.
*
* @method
* @param {ve.dm.LinkAnnotation} annotation Link annotation
*/
ve.ui.LinkTargetInputWidget.prototype.setAnnotation = function ( annotation ) {
this.annotation = annotation;
this.setValue( this.getTargetFromAnnotation( annotation ), 'annotation' );
};
/**
* Gets the annotation value.
*
* @method
* @returns {ve.dm.LinkAnnotation} Link annotation
*/
ve.ui.LinkTargetInputWidget.prototype.getAnnotation = function () {
return this.annotation;
};
/**
* Gets a target from an annotation.
*
* @method
* @param {ve.dm.LinkAnnotation} annotation Link annotation
* @returns {string} Target
*/
ve.ui.LinkTargetInputWidget.prototype.getTargetFromAnnotation = function ( annotation ) {
return annotation.data.href;
};