mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWCategoryItemWidget.js
Timo Tijhof 7db65f386c Rename @emits to @fires so we're forward compatible with JSDuck 5
Instead of using @emits in both, use our custom @fires in
production (JSDuck 4), and in the future it'll just naturally
use the native one.

This way we can also index oojs without issues, which seems to
have started using @fires already.

Change-Id: I7c3b56dd112626d57fa87ab995d205fb782a0149
2013-10-22 19:11:16 +00:00

91 lines
2.1 KiB
JavaScript

/*!
* VisualEditor UserInterface MWCategoryItemWidget class.
*
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWCategoryItemWidget object.
*
* @class
* @abstract
* @extends ve.ui.Widget
*
* @constructor
* @param {Object} [config] Configuration options
* @cfg {Object} [item] Category item
*/
ve.ui.MWCategoryItemWidget = function VeUiMWCategoryItemWidget( config ) {
// Config intialization
config = config || {};
// Parent constructor
ve.ui.Widget.call( this, config );
// Properties
this.name = config.item.name;
this.value = config.item.value;
this.sortKey = config.item.sortKey || '';
this.metaItem = config.item.metaItem;
this.menuOpen = false;
this.$label = this.$$( '<span>' );
this.$arrow = this.$$( '<div>' );
this.$categoryItem = this.$$( '<div>' );
// Events
this.$categoryItem.on( {
'click': ve.bind( this.onClick, this ),
'mounsedown': ve.bind( this.onMouseDown, this )
} );
// Initialization
this.$label.text( this.value );
this.$arrow.addClass( 've-ui-mwCategoryItemControl ve-ui-icon-down' );
this.$categoryItem
.addClass( 've-ui-mwCategoryItemButton' )
.append( this.$label, this.$arrow, this.$$( '<div>' ).css( 'clear', 'both' ) );
this.$
.addClass( 've-ui-mwCategoryItemWidget' )
.append( this.$categoryItem );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWCategoryItemWidget, ve.ui.Widget );
/* 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 );
};