mediawiki-extensions-VisualEditor/modules/ve/ui/widgets/ve.ui.ButtonWidget.js

/*!
 * VisualEditor UserInterface ButtonWidget class.
 *
 * @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Creates an ve.ui.ButtonWidget object.
 *
 * @class
 * @extends ve.ui.Widget
 * @mixins ve.ui.FlaggableElement
 * @mixins ve.ui.LabeledElement
 *
 * @constructor
 * @param {Object} [config] Configuration options
 * @cfg {number} [tabIndex] Button's tab index
 */
ve.ui.ButtonWidget = function VeUiButtonWidget( config ) {
	// Parent constructor
	ve.ui.Widget.call( this, config );

	// Mixin constructors
	ve.ui.FlaggableElement.call( this, config );
	ve.ui.LabeledElement.call( this, this.$$( '<span>' ), config );

	// Events
	this.$.on( 'click', ve.bind( this.onClick, this ) );
	this.$.on( 'keypress', ve.bind( this.onKeyPress, this ) );

	// Initialization
	this.$.attr( {
		'role': 'button',
		'tabIndex': config.tabIndex || 0
	} );
	this.$.addClass( 've-ui-buttonWidget' ).append( this.$label );
};

/* Inheritance */

ve.inheritClass( ve.ui.ButtonWidget, ve.ui.Widget );

ve.mixinClass( ve.ui.ButtonWidget, ve.ui.FlaggableElement );

ve.mixinClass( ve.ui.ButtonWidget, ve.ui.LabeledElement );

/* Events */

/**
 * @event click
 */

/* Methods */

/**
 * Handles mouse click events.
 *
 * @method
 * @param {jQuery.Event} e Mouse click event
 * @emits click
 */
ve.ui.ButtonWidget.prototype.onClick = function () {
	if ( !this.disabled ) {
		this.emit( 'click' );
	}
	return false;
};

/**
 * Handles keypress events.
 *
 * @method
 * @param {jQuery.Event} e Keypress event
 * @emits click
 */
ve.ui.ButtonWidget.prototype.onKeyPress = function ( e ) {
	if ( !this.disabled && e.which === ve.Keys.SPACE ) {
		this.emit( 'click' );
	}
	return false;
};