mediawiki-extensions-Visual.../modules/oojs-ui/elements/OO.ui.GroupElement.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

120 lines
2.6 KiB
JavaScript

/*!
* ObjectOriented UserInterface GroupElement class.
*
* @copyright 2011-2013 OOJS Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Element containing a sequence of child elements.
*
* @class
* @abstract
*
* @constructor
* @param {jQuery} $group Container node, assigned to #$group
*/
OO.ui.GroupElement = function OoUiGroupElement( $group ) {
// Properties
this.$group = $group;
this.items = [];
this.$items = this.$( [] );
};
/* Methods */
/**
* Get items.
*
* @method
* @returns {OO.ui.Element[]} Items
*/
OO.ui.GroupElement.prototype.getItems = function () {
return this.items.slice( 0 );
};
/**
* Add items.
*
* @method
* @param {OO.ui.Element[]} items Item
* @param {number} [index] Index to insert items after
* @chainable
*/
OO.ui.GroupElement.prototype.addItems = function ( items, index ) {
var i, len, item, currentIndex,
$items = this.$( [] );
for ( i = 0, len = items.length; i < len; i++ ) {
item = items[i];
// Check if item exists then remove it first, effectively "moving" it
currentIndex = this.items.indexOf( item );
if ( currentIndex >= 0 ) {
this.removeItems( [ item ] );
// Adjust index to compensate for removal
if ( currentIndex < index ) {
index--;
}
}
// Add the item
$items = $items.add( item.$element );
}
if ( index === undefined || index < 0 || index >= this.items.length ) {
this.$group.append( $items );
this.items.push.apply( this.items, items );
} else if ( index === 0 ) {
this.$group.prepend( $items );
this.items.unshift.apply( this.items, items );
} else {
this.$items.eq( index ).before( $items );
this.items.splice.apply( this.items, [ index, 0 ].concat( items ) );
}
this.$items = this.$items.add( $items );
return this;
};
/**
* Remove items.
*
* Items will be detached, not removed, so they can be used later.
*
* @method
* @param {OO.ui.Element[]} items Items to remove
* @chainable
*/
OO.ui.GroupElement.prototype.removeItems = function ( items ) {
var i, len, item, index;
// Remove specific items
for ( i = 0, len = items.length; i < len; i++ ) {
item = items[i];
index = this.items.indexOf( item );
if ( index !== -1 ) {
this.items.splice( index, 1 );
item.$element.detach();
this.$items = this.$items.not( item.$element );
}
}
return this;
};
/**
* Clear all items.
*
* Items will be detached, not removed, so they can be used later.
*
* @method
* @chainable
*/
OO.ui.GroupElement.prototype.clearItems = function () {
this.items = [];
this.$items.detach();
this.$items = this.$( [] );
return this;
};