mediawiki-extensions-VisualEditor/modules/ve/ui/ve.ui.Widget.js

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

/**
 * Creates an ve.ui.Widget object.
 *
 * @class
 * @abstract
 * @extends ve.EventEmitter
 *
 * @constructor
 * @param {Object} [config] Config options
 * @cfg {Function} [$$=$] jQuery for the frame the widget is in
 * @cfg {boolean} [disabled=false] Disable
 */
ve.ui.Widget = function VeUiWidget( config ) {
	// Initialize config
	config = ve.extendObject( { '$$': $, 'disabled': false }, config );

	// Parent constructor
	ve.EventEmitter.call( this );

	// Properties
	this.$$ = config.$$;
	this.$ = this.$$( '<' + this.constructor.static.tagName + '>' );
	this.disabled = config.disabled;

	// Initialization
	this.$.addClass( 've-ui-widget' );
	this.setDisabled( this.disabled );
};

/* Inheritance */

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

/* Static Properties */

/**
 * HTML element name.
 *
 * @static
 * @property
 * @type {string}
 * @inheritable
 */
ve.ui.Widget.static.tagName = 'div';

/* Methods */

/**
 * Check if the widget is disabled.
 *
 * @method
 * @param {boolean} Button is disabled
 */
ve.ui.Widget.prototype.isDisabled = function () {
	return this.disabled;
};

/**
 * Set the disabled state of the widget.
 *
 * This should probably change the widgets's appearance and prevent it from being used.
 *
 * @method
 * @param {boolean} state Disable button
 * @chainable
 */
ve.ui.Widget.prototype.setDisabled = function ( state ) {
	this.disabled = !!state;
	if ( this.disabled ) {
		this.$.addClass( 've-ui-widget-disabled' );
	} else {
		this.$.removeClass( 've-ui-widget-disabled' );
	}
	return this;
};