mediawiki-extensions-Visual.../modules/oojs-ui/widgets/OO.ui.TextInputWidget.js
Trevor Parscal db9f941fa6 Rename this.$ to this.$element, and this.$$ to this.$
Objectives:
* Rename this.$ to this.$element
* Rename this.$$ to this.$
* Get rid of the need to use this.frame.$$
* Rename OO.ui.Element.get$$ to OO.ui.Element.getJQuery

Changes: (using Sublime Text regex patterns)
* Replace "get$$" with "getJQuery"
* Replace "\.(\$)([^\$a-zA-Z])" with ".$element$2"
* Replace "\.(\$\$)" with ".$"
* Replace "'$$'" with "'$'"
* Set this.$ to null in constructor of OO.ui.Window
* Set this.$ to this.frame.$ in initialize method of OO.ui.Window
* Replace "\.(frame.\$)([^\$a-zA-Z])" with ".\$$2"

Bonus:
* Use this.$() in a bunch of places where $() was erroneously used

Change-Id: If3d870124ab8d10f8223532cda95c2b2b075db94
2013-11-03 23:03:49 -08:00

131 lines
2.9 KiB
JavaScript

/*!
* ObjectOriented UserInterface TextInputWidget class.
*
* @copyright 2011-2013 OOJS Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an OO.ui.TextInputWidget object.
*
* @class
* @extends OO.ui.InputWidget
*
* @constructor
* @param {Object} [config] Configuration options
* @cfg {string} [placeholder] Placeholder text
* @cfg {string} [icon] Symbolic name of icon
* @cfg {boolean} [multiline=false] Allow multiple lines of text
*/
OO.ui.TextInputWidget = function OoUiTextInputWidget( config ) {
config = config || {};
// Parent constructor
OO.ui.InputWidget.call( this, config );
// Properties
this.pending = 0;
this.multiline = !!config.multiline;
// Events
this.$input.on( 'keypress', OO.ui.bind( this.onKeyPress, this ) );
// Initialization
this.$element.addClass( 'oo-ui-textInputWidget' );
if ( config.icon ) {
this.$element.addClass( 'oo-ui-textInputWidget-decorated' );
this.$element.append(
this.$( '<span>' )
.addClass( 'oo-ui-textInputWidget-icon oo-ui-icon-' + config.icon )
.mousedown( OO.ui.bind( function () {
this.$input.focus();
return false;
}, this ) )
);
}
if ( config.placeholder ) {
this.$input.attr( 'placeholder', config.placeholder );
}
};
/* Inheritance */
OO.inheritClass( OO.ui.TextInputWidget, OO.ui.InputWidget );
/* Events */
/**
* User presses enter inside the text box.
*
* Not called if input is multiline.
*
* @event enter
*/
/* Methods */
/**
* Handles key press events.
*
* @param {jQuery.Event} e Key press event
* @fires enter If enter key is pressed and input is not multiline
*/
OO.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
if ( e.which === OO.ui.Keys.ENTER && !this.multiline ) {
this.emit( 'enter' );
}
};
/**
* Get input element.
*
* @method
* @param {Object} [config] Configuration options
* @returns {jQuery} Input element
*/
OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
return config.multiline ? this.$( '<textarea>' ) : this.$( '<input>' ).attr( 'type', 'text' );
};
/* Methods */
/**
* Checks if input is pending.
*
* @method
* @returns {boolean} Input is pending
*/
OO.ui.TextInputWidget.prototype.isPending = function () {
return !!this.pending;
};
/**
* Increases the pending stack.
*
* @method
* @chainable
*/
OO.ui.TextInputWidget.prototype.pushPending = function () {
this.pending++;
this.$element.addClass( 'oo-ui-textInputWidget-pending' );
this.$input.addClass( 'oo-ui-texture-pending' );
return this;
};
/**
* Reduces the pending stack.
*
* Clamped at zero.
*
* @method
* @chainable
*/
OO.ui.TextInputWidget.prototype.popPending = function () {
this.pending = Math.max( 0, this.pending - 1 );
if ( !this.pending ) {
this.$element.removeClass( 'oo-ui-textInputWidget-pending' );
this.$input.removeClass( 'oo-ui-texture-pending' );
}
return this;
};