mediawiki-extensions-Visual.../modules/ve-mw/ui/dialogs/ve.ui.MWReferenceListDialog.js
Timo Tijhof 8f05cdbf70 doc: Add placeholders for unindexed methods
Not having a description yet is fine, but they should at least
be indexed as blocks so that they are searchable and listed
in the jsduck generated pages. jsduck defaults to @method + name
of prototype property. And it even guesses parameters sometimes.

Search: \n\n([a-zA-Z\.]+\.prototype\.[a-zA-Z]+)
Where: modules/ve,modules/ve-mw
Where-Not: modules/ve/test
Replace: \n\n/** */\n$1

Added @return in a few places where it was easy to add.

Change-Id: I830c94cc7dbc261bd7a077391f930cbfff165f9d
2013-07-31 23:00:30 +00:00

152 lines
3.8 KiB
JavaScript

/*!
* VisualEditor user interface MWReferenceListDialog class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Dialog for inserting and editing MediaWiki reference lists.
*
* @class
* @extends ve.ui.MWDialog
*
* @constructor
* @param {ve.ui.Surface} surface
* @param {Object} [config] Config options
*/
ve.ui.MWReferenceListDialog = function VeUiMWReferenceListDialog( surface, config ) {
// Parent constructor
ve.ui.MWDialog.call( this, surface, config );
};
/* Inheritance */
ve.inheritClass( ve.ui.MWReferenceListDialog, ve.ui.MWDialog );
/* Static Properties */
ve.ui.MWReferenceListDialog.static.titleMessage = 'visualeditor-dialog-referencelist-title';
ve.ui.MWReferenceListDialog.static.icon = 'references';
/* Methods */
/** */
ve.ui.MWReferenceListDialog.prototype.initialize = function () {
// Parent method
ve.ui.MWDialog.prototype.initialize.call( this );
// Properties
this.editPanel = new ve.ui.PanelLayout( {
'$$': this.frame.$$, 'scrollable': true, 'padded': true
} );
this.optionsFieldset = new ve.ui.FieldsetLayout( {
'$$': this.frame.$$,
'label': ve.msg( 'visualeditor-dialog-reference-options-section' ),
'icon': 'settings'
} );
this.groupInput = new ve.ui.TextInputWidget( { '$$': this.frame.$$ } );
this.groupLabel = new ve.ui.InputLabelWidget( {
'$$': this.frame.$$,
'input': this.groupInput,
'label': ve.msg( 'visualeditor-dialog-reference-options-group-label' )
} );
this.applyButton = new ve.ui.ButtonWidget( {
'$$': this.$$, 'label': ve.msg( 'visualeditor-dialog-action-apply' ), 'flags': ['primary']
} );
// Events
this.applyButton.connect( this, { 'click': [ 'close', 'apply' ] } );
// Initialization
this.optionsFieldset.$.append( this.groupLabel.$, this.groupInput.$ );
this.editPanel.$.append( this.optionsFieldset.$ );
this.$body.append( this.editPanel.$ );
this.$foot.append( this.applyButton.$ );
};
/** */
ve.ui.MWReferenceListDialog.prototype.onOpen = function () {
var node, refGroup;
// Parent method
ve.ui.MWDialog.prototype.onOpen.call( this );
// Prepopulate from existing node if we're editing a node
// instead of inserting a new one
node = this.surface.getView().getFocusedNode();
if ( node instanceof ve.ce.MWReferenceListNode ) {
refGroup = node.getModel().getAttribute( 'refGroup' );
} else {
refGroup = '';
}
this.groupInput.setValue( refGroup );
/**
* Focused node.
*
* @private
* @property {ve.ce.MWReferenceListNode|undefined}
*/
this.node = node;
};
/**
* @param {string} action Action that caused the window to be closed
*/
ve.ui.MWReferenceListDialog.prototype.onClose = function ( action ) {
var refGroup, listGroup, oldListGroup, attrChanges,
doc, model,
surfaceModel = this.surface.getModel(),
node = this.node;
// Save changes
if ( action === 'apply' ) {
refGroup = this.groupInput.getValue();
listGroup = 'mwReference/' + refGroup;
if ( node ) {
// Edit existing model
doc = surfaceModel.getDocument();
model = node.getModel();
oldListGroup = model.getAttribute( 'listGroup' );
if ( listGroup !== oldListGroup ) {
attrChanges = {
listGroup: listGroup,
refGroup: refGroup
};
surfaceModel.change(
ve.dm.Transaction.newFromAttributeChanges(
doc, model.getOuterRange().start, attrChanges
)
);
}
} else {
// Create new model
surfaceModel.getFragment().collapseRangeToEnd().insertContent( [
{
'type': 'mwReferenceList',
'attributes': {
'listGroup': listGroup,
'refGroup': refGroup
}
},
{ 'type': '/mwReferenceList' }
] );
}
}
// Parent method
ve.ui.MWDialog.prototype.onClose.call( this );
};
/* Registration */
ve.ui.dialogFactory.register( 'mwReferenceList', ve.ui.MWReferenceListDialog );