/*!
 * Ext JS Library 3.3.0
 * Copyright(c) 2006-2010 Ext JS, Inc.
 * licensing@extjs.com
 * http://www.extjs.com/license
 */
/** 
 * @class Ext.ux.grid.filter.StringFilter
 * @extends Ext.ux.grid.filter.Filter
 * Filter by a configurable Ext.form.TextField
 * <p><b><u>Example Usage:</u></b></p>
 * <pre><code>    
var filters = new Ext.ux.grid.GridFilters({
	...
	filters: [{
		// required configs
		type: 'string',
		dataIndex: 'name',

		// optional configs
		value: 'foo',
		active: true, // default is false
		iconCls: 'ux-gridfilter-text-icon' // default
		// any Ext.form.TextField configs accepted
	}]
});
 * </code></pre>
 */
Ext.ux.grid.filter.StringFilter = Ext.extend(Ext.ux.grid.filter.Filter, {

	/**
	 * @cfg {String} iconCls
	 * The iconCls to be applied to the menu item.
	 * Defaults to <tt>'ux-gridfilter-text-icon'</tt>.
	 */
	iconCls : 'ux-gridfilter-text-icon',

	emptyText: 'Enter Filter Text...',
	selectOnFocus: true,
	width: 125,

	/**
	 * @private
	 * Template method that is to initialize the filter and install required menu items.
	 */
	init : function (config) {
		Ext.applyIf(config, {
			enableKeyEvents: true,
			iconCls: this.iconCls,
			listeners: {
				scope: this,
				keyup: this.onInputKeyUp
			}
		});

		this.inputItem = new Ext.form.TextField(config);
		this.menu.add(this.inputItem);
		this.updateTask = new Ext.util.DelayedTask(this.fireUpdate, this);
	},

	/**
	 * @private
	 * Template method that is to get and return the value of the filter.
	 * @return {String} The value of this filter
	 */
	getValue : function () {
		return this.inputItem.getValue();
	},

	/**
	 * @private
	 * Template method that is to set the value of the filter.
	 * @param {Object} value The value to set the filter
	 */
	setValue : function (value) {
		this.inputItem.setValue(value);
		this.fireEvent('update', this);
	},

	/**
	 * @private
	 * Template method that is to return <tt>true</tt> if the filter
	 * has enough configuration information to be activated.
	 * @return {Boolean}
	 */
	isActivatable : function () {
		return this.inputItem.getValue().length > 0;
	},

	/**
	 * @private
	 * Template method that is to get and return serialized filter data for
	 * transmission to the server.
	 * @return {Object/Array} An object or collection of objects containing
	 * key value pairs representing the current configuration of the filter.
	 */
	getSerialArgs : function () {
		return {type: 'string', value: this.getValue()};
	},

	/**
	 * Template method that is to validate the provided Ext.data.Record
	 * against the filters configuration.
	 * @param {Ext.data.Record} record The record to validate
	 * @return {Boolean} true if the record is valid within the bounds
	 * of the filter, false otherwise.
	 */
	validateRecord : function (record) {
		var val = record.get(this.dataIndex);

		if(typeof val != 'string') {
			return (this.getValue().length === 0);
		}

		return val.toLowerCase().indexOf(this.getValue().toLowerCase()) > -1;
	},

	/**
	 * @private
	 * Handler method called when there is a keyup event on this.inputItem
	 */
	onInputKeyUp : function (field, e) {
		var k = e.getKey();
		if (k == e.RETURN && field.isValid()) {
			e.stopEvent();
			this.menu.hide(true);
			return;
		}
		// restart the timer
		this.updateTask.delay(this.updateBuffer);
	}
});
