mediawiki-extensions-Visual.../modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
Roan Kattouw 92c38eab85 The great directory split of 2013
Move all MW-specific files into the ve-mw directory, in preparation
for moving them out into a separate repo.

All MW-specific files were moved into a parallel directory structure
in modules/ve-mw . Files with both generic and MW-specific things were
split up. Files in ve/init/mw/ were moved to ve-mw/init/ rather than
ve-mw/init/mw ; they're still named ve.init.mw.* but we should change
that. Some of the test files for core classes had MW-specific test cases,
so those were split up and the test runner was duplicated; we should
refactor our tests to use data providers so we can add cases more easily.

Split files:
* ve.ce.Node.css
* ve.ce.ContentBranchNode.test.js (MWEntityNode)
* ve.ce.Document.test.js (some core test cases genericized)
* ve.dm.InternalList.test.js (uses mwReference test document)
* ve.dm.SurfaceFragment.test.js, ve.ui.FormatAction.test.js
** Made core tests use heading instead of mwHeading
** Updated core tests because normal headings don't break out of lists
** Moved test runners into ve.test.utils.js
* ve.ui.Icons-*.css
* ve.ui.Dialog.css (MW parts into ve.ui.MWDialog.css)
* ve.ui.Tool.css
* ve.ui.Widget.css (move ve-ui-rtl and ve-ui-ltr to ve.ui.css)

ve.dm.Converter.test.js: Moved runner functions into ve.test.utils.js

ve.dm.example.js:
* Refactored createExampleDocument so mwExample can use it
* Removed wgExtensionAssetsPath detection, moved into mw-preload.js
* Genericized withMeta example document (original version copied to mwExample)
* Moved references example document to mwExample

ve.dm.mwExample.js:
* Move withMeta and references example documents from ve.dm.example.js
* Add createExampleDocument function

ve-mw/test/index.php: Runner for MW-specific tests only

ve-mw/test/mw-preload.js: Sets VE_TESTDIR for Special:JavaScriptTest only

ve.ui.Window.js:
* Remove magic path interpolation in addLocalStyleSheets()
* Pass full(er) paths to addLocalStyleSheets(), here and in subclasses

ve.ui.MWDialog.js: Subclass of Dialog that adds MW versions of stylesheets

ve.ui.MW*Dialog.js:
* Subclass MWDialog rather than Dialog
* Load both core and MW versions of stylesheets that have both

ve.ui.PagedDialog.js: Converted to a mixin rather than an abstract base class
* Don't inherit ve.ui.Dialog
* Rather than overriding initialize(), provide initializePages() which the
  host class is supposed to call from its initialize()
* Rename onOutlineSelect to onPageOutlineSelect

ve.ui.MWMetaDialog.js, ve.ui.MWTransclusionDialog.js:
* Use PagedDialog as a mixin rather than a base class, inherit MWDialog

bullet-icon.png: Unused, deleted

Stuff we should do later:
* Refactor tests to use data providers
* Write utility function for SVG compat check
* Separate omnibus CSS files such as ve.ui.Widget.css
* Separate omnibus RL modules
* Use icon classes in ViewPageTarget

Change-Id: I1b28f8ba7f2d2513e5c634927a854686fb9dd5a5
2013-07-02 20:51:38 -07:00

163 lines
3.5 KiB
JavaScript

/*!
* VisualEditor DataModel MWTemplateModel class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* MediaWiki template model.
*
* @class
* @extends ve.dm.MWTransclusionPartModel
*
* @constructor
* @param {ve.dm.MWTransclusionModel} transclusion Transclusion
* @param {Object} target Template target
* @param {string} target.wt Original wikitext of target
* @param {string} [target.href] Hypertext reference to target
*/
ve.dm.MWTemplateModel = function VeDmMWTemplateModel( transclusion, target ) {
// Parent constructor
ve.dm.MWTransclusionPartModel.call( this, transclusion );
// Properties
this.target = target;
this.title = ( target.href && target.href.replace( /^(\.\.?\/)*/, '' ) ) || null;
this.sequence = null;
this.params = {};
this.spec = new ve.dm.MWTemplateSpecModel( this );
};
/* Inheritance */
ve.inheritClass( ve.dm.MWTemplateModel, ve.dm.MWTransclusionPartModel );
/* Events */
/**
* @event add
* @param {ve.dm.MWTemplateParameterModel} param Added param
*/
/**
* @event remove
* @param {ve.dm.MWTemplateParameterModel} param Removed param
*/
/* Methods */
/**
* Get template target.
*
* @method
* @returns {Object} Template target
*/
ve.dm.MWTemplateModel.prototype.getTarget = function () {
return this.target;
};
/**
* Get template title.
*
* @method
* @returns {string|null} Template title, if available
*/
ve.dm.MWTemplateModel.prototype.getTitle = function () {
return this.title;
};
/**
* Get template specification.
*
* @method
* @returns {ve.dm.MWTemplateSpecModel} Template specification
*/
ve.dm.MWTemplateModel.prototype.getSpec = function () {
return this.spec;
};
/**
* Get all params.
*
* @method
* @returns {Object.<string,ve.dm.MWTemplateParameterModel>} Parameters keyed by name
*/
ve.dm.MWTemplateModel.prototype.getParameters = function () {
return this.params;
};
/**
* Get a parameter.
*
* @method
* @param {string} name Parameter name
* @returns {ve.dm.MWTemplateParameterModel} Parameter
*/
ve.dm.MWTemplateModel.prototype.getParameter = function ( name ) {
return this.params[name];
};
/**
* Get ordered list of parameter names.
*
* Numeric names, whether strings or real numbers, are placed at the begining, followed by
* alphabetically sorted names.
*
* @method
* @returns {string[]} List of parameter names
*/
ve.dm.MWTemplateModel.prototype.getParameterNames = function () {
if ( !this.sequence ) {
this.sequence = ve.getObjectKeys( this.params ).sort( function ( a, b ) {
var aIsNaN = isNaN( a ),
bIsNaN = isNaN( b );
if ( aIsNaN && bIsNaN ) {
// Two strings
return a < b ? -1 : a === b ? 0 : 1;
}
if ( aIsNaN ) {
// A is a string
return 1;
}
if ( bIsNaN ) {
// B is a string
return -1;
}
// Two numbers
return a - b;
} );
}
return this.sequence;
};
/**
* Add a parameter to template.
*
* @method
* @param {ve.dm.MWTemplateParameterModel} param Parameter to add
* @emits add
*/
ve.dm.MWTemplateModel.prototype.addParameter = function ( param ) {
var name = param.getName();
this.sequence = null;
this.params[name] = param;
this.spec.fill();
this.emit( 'add', param );
};
/**
* Remove parameter from template.
*
* @method
* @param {ve.dm.MWTemplateParameterModel} param Parameter to remove
* @emits remove
*/
ve.dm.MWTemplateModel.prototype.removeParameter = function ( param ) {
if ( param ) {
this.sequence = null;
delete this.params[param.getName()];
this.emit( 'remove', param );
}
};