/**
* Any OOjs UI widget that contains other widgets (such as {@link OO.ui.ButtonWidget buttons} or
* {@link OO.ui.OptionWidget options}) mixes in GroupElement. Adding, removing, and clearing
* items from the group is done through the interface the class provides.
* For more information, please see the [OOjs UI documentation on MediaWiki] [1].
*
* [1]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Groups
*
* @mixin
* @mixes OO.EmitterList
*
* @param {Object} [config] Configuration options
* @param {jQuery} [config.$group] The container element created by the class. If this configuration
* is omitted, the group element will use a generated `<div>`.
*/
OO.ui.mixin.GroupElement = function OoUiMixinGroupElement( config ) {
// Configuration initialization
config = config || {};
// Mixin constructors
OO.EmitterList.call( this, config );
// Properties
this.$group = null;
// Initialization
this.setGroupElement( config.$group || $( '<div>' ) );
};
/* Setup */
OO.mixinClass( OO.ui.mixin.GroupElement, OO.EmitterList );
/* Events */
/**
* @event change
*
* A change event is emitted when the set of selected items changes.
*
* @param {OO.ui.Element[]} items Items currently in the group
*/
/* Methods */
/**
* Set the group element.
*
* If an element is already set, items will be moved to the new element.
*
* @param {jQuery} $group Element to use as group
*/
OO.ui.mixin.GroupElement.prototype.setGroupElement = function ( $group ) {
var i, len;
this.$group = $group;
for ( i = 0, len = this.items.length; i < len; i++ ) {
this.$group.append( this.items[ i ].$element );
}
};
/**
* Find an item by its data.
*
* Only the first item with matching data will be returned. To return all matching items,
* use the #findItemsFromData method.
*
* @param {Object} data Item data to search for
* @return {OO.ui.Element|null} Item with equivalent data, `null` if none exists
*/
OO.ui.mixin.GroupElement.prototype.findItemFromData = function ( data ) {
var i, len, item,
hash = OO.getHash( data );
for ( i = 0, len = this.items.length; i < len; i++ ) {
item = this.items[ i ];
if ( hash === OO.getHash( item.getData() ) ) {
return item;
}
}
return null;
};
/**
* Get an item by its data.
*
* @deprecated Since v0.25.0; use {@link #findItemFromData} instead.
* @param {Object} data Item data to search for
* @return {OO.ui.Element|null} Item with equivalent data, `null` if none exists
*/
OO.ui.mixin.GroupElement.prototype.getItemFromData = function ( data ) {
OO.ui.warnDeprecation( 'GroupElement#getItemFromData. Deprecated function. Use findItemFromData instead. See T76630' );
return this.findItemFromData( data );
};
/**
* Find items by their data.
*
* All items with matching data will be returned. To return only the first match, use the #findItemFromData method instead.
*
* @param {Object} data Item data to search for
* @return {OO.ui.Element[]} Items with equivalent data
*/
OO.ui.mixin.GroupElement.prototype.findItemsFromData = function ( data ) {
var i, len, item,
hash = OO.getHash( data ),
items = [];
for ( i = 0, len = this.items.length; i < len; i++ ) {
item = this.items[ i ];
if ( hash === OO.getHash( item.getData() ) ) {
items.push( item );
}
}
return items;
};
/**
* Find items by their data.
*
* @deprecated Since v0.25.0; use {@link #findItemsFromData} instead.
* @param {Object} data Item data to search for
* @return {OO.ui.Element[]} Items with equivalent data
*/
OO.ui.mixin.GroupElement.prototype.getItemsFromData = function ( data ) {
OO.ui.warnDeprecation( 'GroupElement#getItemsFromData. Deprecated function. Use findItemsFromData instead. See T76630' );
return this.findItemsFromData( data );
};
/**
* Add items to the group.
*
* Items will be added to the end of the group array unless the optional `index` parameter specifies
* a different insertion point. Adding an existing item will move it to the end of the array or the point specified by the `index`.
*
* @param {OO.ui.Element[]} items An array of items to add to the group
* @param {number} [index] Index of the insertion point
* @chainable
*/
OO.ui.mixin.GroupElement.prototype.addItems = function ( items, index ) {
// Mixin method
OO.EmitterList.prototype.addItems.call( this, items, index );
this.emit( 'change', this.getItems() );
return this;
};
/**
* @inheritdoc
*/
OO.ui.mixin.GroupElement.prototype.moveItem = function ( items, newIndex ) {
// insertItemElements expects this.items to not have been modified yet, so call before the mixin
this.insertItemElements( items, newIndex );
// Mixin method
newIndex = OO.EmitterList.prototype.moveItem.call( this, items, newIndex );
return newIndex;
};
/**
* @inheritdoc
*/
OO.ui.mixin.GroupElement.prototype.insertItem = function ( item, index ) {
item.setElementGroup( this );
this.insertItemElements( item, index );
// Mixin method
index = OO.EmitterList.prototype.insertItem.call( this, item, index );
return index;
};
/**
* Insert elements into the group
*
* @private
* @param {OO.ui.Element} itemWidget Item to insert
* @param {number} index Insertion index
*/
OO.ui.mixin.GroupElement.prototype.insertItemElements = function ( itemWidget, index ) {
if ( index === undefined || index < 0 || index >= this.items.length ) {
this.$group.append( itemWidget.$element );
} else if ( index === 0 ) {
this.$group.prepend( itemWidget.$element );
} else {
this.items[ index ].$element.before( itemWidget.$element );
}
};
/**
* Remove the specified items from a group.
*
* Removed items are detached (not removed) from the DOM so that they may be reused.
* To remove all items from a group, you may wish to use the #clearItems method instead.
*
* @param {OO.ui.Element[]} items An array of items to remove
* @chainable
*/
OO.ui.mixin.GroupElement.prototype.removeItems = function ( items ) {
var i, len, item, index;
// Remove specific items elements
for ( i = 0, len = items.length; i < len; i++ ) {
item = items[ i ];
index = this.items.indexOf( item );
if ( index !== -1 ) {
item.setElementGroup( null );
item.$element.detach();
}
}
// Mixin method
OO.EmitterList.prototype.removeItems.call( this, items );
this.emit( 'change', this.getItems() );
return this;
};
/**
* Clear all items from the group.
*
* Cleared items are detached from the DOM, not removed, so that they may be reused.
* To remove only a subset of items from a group, use the #removeItems method.
*
* @chainable
*/
OO.ui.mixin.GroupElement.prototype.clearItems = function () {
var i, len;
// Remove all item elements
for ( i = 0, len = this.items.length; i < len; i++ ) {
this.items[ i ].setElementGroup( null );
this.items[ i ].$element.detach();
}
// Mixin method
OO.EmitterList.prototype.clearItems.call( this );
this.emit( 'change', this.getItems() );
return this;
};