mediawiki-extensions-Visual.../modules/ve/ui/ve.ui.Widget.js
Trevor Parscal c2defc9783 ve.Element refactor
Objectives:

* Move ve.ui.Element to ve.Element
* Make CE nodes inherit from ve.Element

Changes:

ve.ui.Element.js, ve.Element.js
* Move and rename
* Move ve.ui.get$$ to ve.Element.static.get$$
* Add static getDocument and getWindow methods
* Add instance getElementDocument and getElementWindow methods
* Add getTagName method, which by default reads the static tagName property, but when overridden can return a tag name based on other factors

*.php
* Updated file link

ve.ce.*Annotation.js, ve.ce.*Node.js, ve.ce.View.js, ve.ce.Document
* Added config options pass through
* Replaced passing elements through constructor with defining static tag names
* Added getTagName overrides where needed that derive tag name from model
* Refactore dom wrapper methods, now consistently using getTagName

ve.ce.Surface.js
* Removed static initialization (not needed)

ve.dm.Model.js, ve.ui.Window.js
* Added missing docs

ve.ui.GroupElement.js, ve.ui.Layout.js, ve.ui.Widget.js,
* Updated class name for elements

ve.ui.Frame.js, ve.ui.LookupInputWidget.js
* Updated location of get$$

ve.ui.js
* Move get$$ to ve.Element

ve.js
* Add auto-init of static properties to mixinClass

Change-Id: I39ae14966456903728e4d9e53f806ddce9ca2b70
2013-05-14 19:47:32 +00:00

74 lines
1.5 KiB
JavaScript

/*!
* 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.Element
* @mixin ve.EventEmitter
*
* @constructor
* @param {Object} [config] Config options
* @cfg {boolean} [disabled=false] Disable
*/
ve.ui.Widget = function VeUiWidget( config ) {
// Initialize config
config = ve.extendObject( { 'disabled': false }, config );
// Parent constructor
ve.Element.call( this, config );
// Mixin constructors
ve.EventEmitter.call( this );
// Properties
this.disabled = config.disabled;
// Initialization
this.$.addClass( 've-ui-widget' );
this.setDisabled( this.disabled );
};
/* Inheritance */
ve.inheritClass( ve.ui.Widget, ve.Element );
ve.mixinClass( ve.ui.Widget, ve.EventEmitter );
/* 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;
};