2013-06-21 02:55:16 +00:00
|
|
|
/*!
|
|
|
|
* VisualEditor user interface MWReferenceListDialog class.
|
|
|
|
*
|
|
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
Single-click insertion
Objectives:
* Reduce the number of clicks and mouse maneuvers required to insert
media, references or template parameters
* Make use of highlighting with mouse movement or arrow key presses,
similar to menus, to suggest action when clicked
* Improve the way media search results look and feel
Changes:
ve.ui.SelectWidget.js
* Add mouseleave handler to un-highlight when the mouse exits the widget
* Document highlight events (already being emitted)
ve.ui.SearchWidget.js
* Propagate both select and highlight events from results widget
* Make arrow keys change highlight instead of selection
* Get rid of enter event, make enter key select highlighted item instead
* Provide direct access to results widget through getResults method
ve.ui.MenuWidget.js
* Use the selected item as a starting point if nothing is currently
highlighted when adjusting the highlight position
ve.ui.Dialog.js
* Add footless option to hide the foot element and make the body extend
all the way down to the bottom
* Remove applyButton, which only some dialogs need, and should be creating
themselves, along with other buttons as needed
ve.ui.Widget.css
* Change highlight and selected colors of option widgets to match other
selection colors used elsewhere
* Leave selected and highlighted widget looking selected
ve.ui.Frame.css
* Add background color to combat any color that might have been applied to
the frame body in the imported CSS from the parent frame
ve.ui.Dialog.css
* Add rules for footless mode
ve.ui.MWReferenceResultWidget.js,
ve.ui.MWParameterResultWidget.js,
ve.ui.MWMediaResultWidget.js
* Allow highlighting
ve.ui.MWParamterSearchWidget.js
* Switch from selecting the first item when filtering to highlighting
ve-mw/ve.ui.Widget.js
* Adjust media result widget styling to better match other elements
ve.ui.MWTransclusionDialog.js,
ve.ui.MWReferenceListDialog.js,
ve.ui.MWReferenceEditDialog.js,
ve.ui.MWMetaDialog.js
ve.ui.MWMediaEditDialog.js
* Add apply button, as per it being removed from parent class
ve.ui.MWTransclusionDialog.js,
ve.ui.MWReferenceInsertDialog.js,
ve.ui.MWMediaInsertDialog.js
* Insert parameter/reference/media on select, instead of clicking an
insert button
* Use 'insert' instead of 'apply' as argument for close method
Bug: 50774
Bug: 51143
Change-Id: Ia18e79f1f8df2540f465468edb01f5ce989bf843
2013-07-15 21:07:53 +00:00
|
|
|
* Dialog for inserting and editing MediaWiki reference lists.
|
2013-06-21 02:55:16 +00:00
|
|
|
*
|
|
|
|
* @class
|
2013-07-03 01:30:10 +00:00
|
|
|
* @extends ve.ui.MWDialog
|
2013-06-21 02:55:16 +00:00
|
|
|
*
|
|
|
|
* @constructor
|
2013-10-09 19:59:03 +00:00
|
|
|
* @param {ve.ui.SurfaceWindowSet} windowSet Window set this dialog is part of
|
2013-09-25 10:21:09 +00:00
|
|
|
* @param {Object} [config] Configuration options
|
2013-06-21 02:55:16 +00:00
|
|
|
*/
|
2013-10-09 19:59:03 +00:00
|
|
|
ve.ui.MWReferenceListDialog = function VeUiMWReferenceListDialog( windowSet, config ) {
|
2013-06-21 02:55:16 +00:00
|
|
|
// Parent constructor
|
2013-10-09 19:59:03 +00:00
|
|
|
ve.ui.MWDialog.call( this, windowSet, config );
|
2013-06-21 02:55:16 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Inheritance */
|
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.inheritClass( ve.ui.MWReferenceListDialog, ve.ui.MWDialog );
|
2013-06-21 02:55:16 +00:00
|
|
|
|
|
|
|
/* Static Properties */
|
|
|
|
|
2013-08-27 23:28:29 +00:00
|
|
|
ve.ui.MWReferenceListDialog.static.name = 'referenceList';
|
|
|
|
|
2013-06-21 02:55:16 +00:00
|
|
|
ve.ui.MWReferenceListDialog.static.titleMessage = 'visualeditor-dialog-referencelist-title';
|
|
|
|
|
|
|
|
ve.ui.MWReferenceListDialog.static.icon = 'references';
|
|
|
|
|
|
|
|
/* Methods */
|
|
|
|
|
2013-07-31 22:53:29 +00:00
|
|
|
/** */
|
2013-06-21 02:55:16 +00:00
|
|
|
ve.ui.MWReferenceListDialog.prototype.initialize = function () {
|
|
|
|
// Parent method
|
2013-07-03 01:30:10 +00:00
|
|
|
ve.ui.MWDialog.prototype.initialize.call( this );
|
2013-06-21 02:55:16 +00:00
|
|
|
|
|
|
|
// Properties
|
2013-10-09 20:09:59 +00:00
|
|
|
this.editPanel = new OO.ui.PanelLayout( {
|
2013-11-01 19:45:59 +00:00
|
|
|
'$': this.$, 'scrollable': true, 'padded': true
|
2013-07-17 19:01:49 +00:00
|
|
|
} );
|
2013-10-09 20:09:59 +00:00
|
|
|
this.optionsFieldset = new OO.ui.FieldsetLayout( {
|
2013-11-01 19:45:59 +00:00
|
|
|
'$': this.$,
|
2013-06-21 02:55:16 +00:00
|
|
|
'label': ve.msg( 'visualeditor-dialog-reference-options-section' ),
|
|
|
|
'icon': 'settings'
|
|
|
|
} );
|
|
|
|
|
2013-11-01 19:45:59 +00:00
|
|
|
this.groupInput = new OO.ui.TextInputWidget( { '$': this.$ } );
|
2013-10-09 20:09:59 +00:00
|
|
|
this.groupLabel = new OO.ui.InputLabelWidget( {
|
2013-11-01 19:45:59 +00:00
|
|
|
'$': this.$,
|
2013-06-21 02:55:16 +00:00
|
|
|
'input': this.groupInput,
|
|
|
|
'label': ve.msg( 'visualeditor-dialog-reference-options-group-label' )
|
|
|
|
} );
|
|
|
|
|
2013-10-09 20:09:59 +00:00
|
|
|
this.applyButton = new OO.ui.PushButtonWidget( {
|
2013-11-01 19:45:59 +00:00
|
|
|
'$': this.$, 'label': ve.msg( 'visualeditor-dialog-action-apply' ), 'flags': ['primary']
|
Single-click insertion
Objectives:
* Reduce the number of clicks and mouse maneuvers required to insert
media, references or template parameters
* Make use of highlighting with mouse movement or arrow key presses,
similar to menus, to suggest action when clicked
* Improve the way media search results look and feel
Changes:
ve.ui.SelectWidget.js
* Add mouseleave handler to un-highlight when the mouse exits the widget
* Document highlight events (already being emitted)
ve.ui.SearchWidget.js
* Propagate both select and highlight events from results widget
* Make arrow keys change highlight instead of selection
* Get rid of enter event, make enter key select highlighted item instead
* Provide direct access to results widget through getResults method
ve.ui.MenuWidget.js
* Use the selected item as a starting point if nothing is currently
highlighted when adjusting the highlight position
ve.ui.Dialog.js
* Add footless option to hide the foot element and make the body extend
all the way down to the bottom
* Remove applyButton, which only some dialogs need, and should be creating
themselves, along with other buttons as needed
ve.ui.Widget.css
* Change highlight and selected colors of option widgets to match other
selection colors used elsewhere
* Leave selected and highlighted widget looking selected
ve.ui.Frame.css
* Add background color to combat any color that might have been applied to
the frame body in the imported CSS from the parent frame
ve.ui.Dialog.css
* Add rules for footless mode
ve.ui.MWReferenceResultWidget.js,
ve.ui.MWParameterResultWidget.js,
ve.ui.MWMediaResultWidget.js
* Allow highlighting
ve.ui.MWParamterSearchWidget.js
* Switch from selecting the first item when filtering to highlighting
ve-mw/ve.ui.Widget.js
* Adjust media result widget styling to better match other elements
ve.ui.MWTransclusionDialog.js,
ve.ui.MWReferenceListDialog.js,
ve.ui.MWReferenceEditDialog.js,
ve.ui.MWMetaDialog.js
ve.ui.MWMediaEditDialog.js
* Add apply button, as per it being removed from parent class
ve.ui.MWTransclusionDialog.js,
ve.ui.MWReferenceInsertDialog.js,
ve.ui.MWMediaInsertDialog.js
* Insert parameter/reference/media on select, instead of clicking an
insert button
* Use 'insert' instead of 'apply' as argument for close method
Bug: 50774
Bug: 51143
Change-Id: Ia18e79f1f8df2540f465468edb01f5ce989bf843
2013-07-15 21:07:53 +00:00
|
|
|
} );
|
|
|
|
|
|
|
|
// Events
|
|
|
|
this.applyButton.connect( this, { 'click': [ 'close', 'apply' ] } );
|
|
|
|
|
2013-06-21 02:55:16 +00:00
|
|
|
// Initialization
|
2013-11-01 19:45:59 +00:00
|
|
|
this.optionsFieldset.$element.append( this.groupLabel.$element, this.groupInput.$element );
|
|
|
|
this.editPanel.$element.append( this.optionsFieldset.$element );
|
|
|
|
this.$body.append( this.editPanel.$element );
|
|
|
|
this.$foot.append( this.applyButton.$element );
|
2013-06-21 02:55:16 +00:00
|
|
|
};
|
|
|
|
|
2013-07-31 22:53:29 +00:00
|
|
|
/** */
|
2013-06-21 02:55:16 +00:00
|
|
|
ve.ui.MWReferenceListDialog.prototype.onOpen = function () {
|
|
|
|
var node, refGroup;
|
|
|
|
|
|
|
|
// Parent method
|
2013-07-03 01:30:10 +00:00
|
|
|
ve.ui.MWDialog.prototype.onOpen.call( this );
|
2013-06-21 02:55:16 +00:00
|
|
|
|
|
|
|
// 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
|
2013-07-03 01:30:10 +00:00
|
|
|
ve.ui.MWDialog.prototype.onClose.call( this );
|
2013-06-21 02:55:16 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Registration */
|
|
|
|
|
2013-08-27 23:28:29 +00:00
|
|
|
ve.ui.dialogFactory.register( ve.ui.MWReferenceListDialog );
|