mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWCategoryPopupWidget.js
Timo Tijhof eb0eeb240a clean up: Consistently use MW instead of Mw in constructor names
Most of 'em already do. Fixed the remaining ones.

Change-Id: I1a7ccb27dd66a33265dcaddaa7d34953d328ff87
2013-08-07 17:46:01 +08:00

189 lines
4.7 KiB
JavaScript

/*!
* VisualEditor UserInterface MWCategoryPopupWidget class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWCategoryPopupWidget object.
*
* @class
* @extends ve.ui.PopupWidget
*
* @constructor
* @param {Object} [config] Config options
*/
ve.ui.MWCategoryPopupWidget = function VeUiMWCategoryPopupWidget ( config ) {
// Configuration initialization
config = ve.extendObject( {}, config, { 'autoClose': true } );
// Parent constructor
ve.ui.PopupWidget.call( this, config );
// Properties
this.category = null;
this.origSortkey = null;
this.removed = false;
this.$title = this.$$( '<label>' );
this.$menu = this.$$( '<div>' );
this.removeButton = new ve.ui.IconButtonWidget( {
'$$': this.$$, 'icon': 'remove', 'title': ve.msg( 'visualeditor-inspector-remove-tooltip' )
} );
this.sortKeyInput = new ve.ui.TextInputWidget( { '$$': this.$$ } );
this.sortKeyLabel = new ve.ui.InputLabelWidget(
{ '$$': this.$$, '$input': this.sortKeyInput, 'label': ve.msg ( 'visualeditor-dialog-meta-categories-sortkey-label' ) }
);
this.$sortKeyForm = this.$$( '<form>' ).addClass( 've-ui-mwCategorySortkeyForm' )
.append( this.sortKeyLabel.$, this.sortKeyInput.$ );
// Events
this.connect( this, { 'hide': 'onHide' } );
this.removeButton.connect( this, { 'click': 'onRemoveCategory' } );
this.$sortKeyForm.on( 'submit', ve.bind( this.onSortKeySubmit, this ) );
// Initialization
this.$.addClass( 've-ui-mwCategoryPopupMenu' ).hide();
this.$title
.addClass( 've-ui-mwCategoryPopupTitle ve-ui-icon-tag' )
.text( ve.msg( 'visualeditor-dialog-meta-categories-category' ) );
this.$menu.append(
this.$title,
this.removeButton.$.addClass( 've-ui-mwCategoryRemoveButton' ),
this.$sortKeyForm
);
this.$body.append( this.$menu );
config.$overlay.append( this.$ );
};
/**
* @private
* @cfg {boolean} [autoClose=true] Overridden in this subclass
*/
/* Inheritance */
ve.inheritClass( ve.ui.MWCategoryPopupWidget, ve.ui.PopupWidget );
/* Events */
/**
* @event removeCategory
* @param {string} category Category name
*/
/**
* @event updateSortkey
* @param {string} category Category name
* @param {string} sortkey New sortkey
*/
/* Methods */
/**
* Handle category remove events.
*
* @method
* @emits removeCategory
*/
ve.ui.MWCategoryPopupWidget.prototype.onRemoveCategory = function () {
this.removed = true;
this.emit( 'removeCategory', this.category );
this.closePopup();
};
/**
* Handle sort key form submit events.
*
* @method
* @param {jQuery.Event} e Form submit event
* @emits updateSortkey
*/
ve.ui.MWCategoryPopupWidget.prototype.onSortKeySubmit = function () {
this.closePopup();
return false;
};
/**
* Open a category item popup.
*
* @method
* @param {ve.ui.MWCategoryItemWidget} item Category item
*/
ve.ui.MWCategoryPopupWidget.prototype.openPopup = function ( item ) {
this.show();
this.popupOpen = true;
this.category = item.value;
this.loadCategoryIntoPopup( item );
this.setPopup( item );
};
/**
* Handle popup hide events.
*
* @method
*/
ve.ui.MWCategoryPopupWidget.prototype.onHide = function() {
var newSortkey = this.sortKeyInput.$input.val();
if ( !this.removed && newSortkey !== this.origSortkey ) {
this.emit( 'updateSortkey', this.category, this.sortKeyInput.$input.val() );
}
};
/**
* Load item information into the popup.
*
* @method
* @param {ve.ui.MWCategoryItemWidget} item Category item
*/
ve.ui.MWCategoryPopupWidget.prototype.loadCategoryIntoPopup = function ( item ) {
this.origSortkey = item.sortkey;
this.sortKeyInput.$input.val( item.sortKey );
};
/**
* Close the popup.
*
* @method
*/
ve.ui.MWCategoryPopupWidget.prototype.closePopup = function () {
this.hide();
this.popupOpen = false;
};
/**
* Set the default sort key.
*
* @method
* @param {string} value Default sort key value
*/
ve.ui.MWCategoryPopupWidget.prototype.setDefaultSortKey = function ( value ) {
this.sortKeyInput.$input.attr( 'placeholder', value );
};
/**
* Display the popup next to an item.
*
* @method
* @param {ve.ui.MWCategoryItemWidget} item Category item
*/
ve.ui.MWCategoryPopupWidget.prototype.setPopup = function ( item ) {
var left = item.$arrow.offset().left + ( item.$arrow.width() / 2 ),
top = item.$arrow.offset().top + item.$arrow.height(),
width = this.$menu.outerWidth( true ),
height = this.$menu.outerHeight( true );
// Flip for RTL:
if ( this.$container.attr( 'dir' ) === 'rtl' ) {
// flip me, I'm a mirror:
this.$.css( {
'right': this.$container.outerWidth( true ) - left,
'top': top
} );
} else {
this.$.css( { 'left': left, 'top': top } );
}
this.display( left, top, width, height );
};