mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWCategoryItemWidget.js
Krenair 9c2e1d8048 Follow redirects in the category widgets
Display the redirects nicely in the UI, etc.

Bug: 52414
Change-Id: Ib62144cb90899d0c525d6f08f6b5f1159b7d2a86
2014-04-16 15:30:14 +00:00

100 lines
2.4 KiB
JavaScript

/*!
* VisualEditor UserInterface MWCategoryItemWidget class.
*
* @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWCategoryItemWidget object.
*
* @class
* @abstract
* @extends OO.ui.Widget
* @mixins OO.ui.IndicatedElement
*
* @constructor
* @param {Object} [config] Configuration options
* @cfg {Object} [item] Category item
* @cfg {boolean} [hidden] Whether the category is hidden or not
* @cfg {string} [redirectTo] The name of the category this category's page redirects to.
*/
ve.ui.MWCategoryItemWidget = function VeUiMWCategoryItemWidget( config ) {
// Config intialization
config = ve.extendObject( { 'indicator': 'down' }, config );
// Parent constructor
OO.ui.Widget.call( this, config );
// Mixin constructors
OO.ui.IndicatedElement.call( this, this.$( '<span>' ), config );
// Properties
this.name = config.item.name;
this.value = config.item.value;
this.sortKey = config.item.sortKey || '';
this.metaItem = config.item.metaItem;
this.isHidden = config.hidden;
this.menuOpen = false;
this.$label = this.$( '<span>' );
this.$categoryItem = this.$( '<div>' );
// Events
this.$categoryItem.on( {
'click': ve.bind( this.onClick, this ),
'mousedown': ve.bind( this.onMouseDown, this )
} );
// Initialization
this.$label
.addClass( 've-ui-mwCategoryItemWidget-label' )
.text( config.redirectTo || this.value );
this.$categoryItem
.addClass( 've-ui-mwCategoryItemWidget-button' )
.append( this.$label, this.$indicator );
this.$element
.addClass( 've-ui-mwCategoryItemWidget' )
.append( this.$categoryItem );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWCategoryItemWidget, OO.ui.Widget );
OO.mixinClass( ve.ui.MWCategoryItemWidget, OO.ui.IndicatedElement );
/* Events */
/**
* @event savePopupState
*/
/**
* @event togglePopupMenu
* @param {ve.ui.MWCategoryItemWidget} item Item to load into popup
*/
/* Methods */
/**
* Handle mouse down events.
*
* @method
* @param {jQuery.Event} e Mouse down event
* @fires savePopupState on mousedown.
*/
ve.ui.MWCategoryItemWidget.prototype.onMouseDown = function () {
this.emit( 'savePopupState' );
};
/**
* Handle mouse click events.
*
* @method
* @param {jQuery.Event} e Mouse click event
* @fires togglePopupMenu on mousedown.
*/
ve.ui.MWCategoryItemWidget.prototype.onClick = function () {
this.emit( 'togglePopupMenu', this );
};