/*
 * ***** BEGIN LICENSE BLOCK *****
 * Version: ZAPL 1.1
 * 
 * The contents of this file are subject to the Zimbra AJAX Public
 * License Version 1.1 ("License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.zimbra.com/license
 * 
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Original Code is: Zimbra AJAX Toolkit.
 * 
 * The Initial Developer of the Original Code is Zimbra, Inc.
 * Portions created by Zimbra are Copyright (C) 2005 Zimbra, Inc.
 * All Rights Reserved.
 * 
 * Contributor(s):
 * 
 * ***** END LICENSE BLOCK *****
 */

/**
* @class
* This class represents a list of items.
*
* @author Conrad Damon
* @param init		true if we're instantiating an object (as opposed to performing inheritance)
*/
function DvList(init) {

	if (arguments.length == 0) return;
	DvModel.call(this, true);

	this._vector = new AjxVector();
	this._idHash = new Object();
	this._evt = new DvEvent();
}

DvList.prototype = new DvModel;
DvList.prototype.constructor = DvList;

DvList.prototype.toString = 
function() {
	return "DvList";
}

/**
* Adds an item to the list.
*
* @param item	the item to add
* @param index	the index at which to add the item (defaults to end of list)
*/
DvList.prototype.add = 
function(item, index) {
	this._vector.add(item, index);
	if (item.id)
		this._idHash[item.id] = item;
}

/**
* Removes an item from the list.
*
* @param item	the item to remove
*/
DvList.prototype.remove = 
function(item) {
	this._vector.remove(item);
	if (item.id)
		delete this._idHash[item.id];
}

/**
* Returns the number of items in the list.
*/
DvList.prototype.size = 
function() {
	return this._vector.size();
}

/**
* Returns the list as an array.
*/
DvList.prototype.getArray =
function() {
	return this._vector.getArray();
}

/**
* Returns the list as a AjxVector.
*/
DvList.prototype.getVector =
function() {
	return this._vector;
}

/**
* Returns the item with the given ID.
*
* @param id		a item ID
*/
DvList.prototype.getById =
function(id) {
	return this._idHash[id];
}

/**
* Clears the list, including its ID hash.
*/
DvList.prototype.clear =
function() {
	// First, let each item run its clear() method
	var a = this.getArray();
	for (var i = 0; i < a.length; i++)
		a[i].clear();

	this._evtMgr.removeAll(DvEvent.L_MODIFY);
	this._vector.removeAll();
	for (var id in this._idHash)
		this._idHash[id] = null;
	this._idHash = new Object();
}

/**
* Returns a vector containing a subset of items of this list
*
* @param offset		index of first item to select
* @param limit		number of items to select
*/
DvList.prototype.getSubList = 
function(offset, limit) {
	var subVector = null;
	var end = (offset + limit > this.size()) ? this.size() : offset + limit;
	var subList = this.getArray();
	if (offset < end)
		subVector = AjxVector.fromArray(subList.slice(offset, end));
	return subVector;
}

// Private/protected methods

// Notify listeners on this list of a model change.
DvList.prototype._eventNotify =
function(event, items, details) {
	if (items.length && this._evtMgr.isListenerRegistered(DvEvent.L_MODIFY)) {
		this._evt.set(event, this);
		this._evt.setDetails(details);
		this._evt.setDetail("items", items);
		this._evtMgr.notifyListeners(DvEvent.L_MODIFY, this._evt);
	}
}

// Returns the index at which the given item should be inserted into this list.
// Subclasses should override to return a meaningful value.
DvList.prototype._sortIndex = 
function(item) {
	return 0;
}