/*-----------------------------------------------------------------------------
	The contents of this file are subject to the Mozilla Public License
	Version 1.1 (the "License"); you may not use this file except in
	compliance with the License.You may obtain a copy of the License at
	http://www.mozilla.org/MPL/MPL-1.1.html
	
	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 Fever Framework code.
	
	The Initial Developer of the Original Code is Romain Ecarnot.
	Portions created by Initial Developer are Copyright (C) 2006
	the Initial Developer. All Rights Reserved.
	
	Contributor(s):
	
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
-----------------------------------------------------------------------------*/

import com.bourre.events.EventType;

import fever.events.AbstractEvent;


/**
 * Event data for keyboard interaction.
 * 
 * @see fever.events.AbstractEvent
 * 
 * @author Romain Ecarnot
 */
class fever.events.KeyboardEvent extends AbstractEvent
{
	//-------------------------------------------------------------------------
	// Events definition
	//-------------------------------------------------------------------------
	
	/** Dispatched when user press key(s). */
	public static var onKeyDownEVENT : EventType = new EventType( 'onKeyDown' );
	
	/** Dispatched when user release key. */
	public static var onKeyUpEVENT : EventType = new EventType( 'onKeyUp' );
	
	
	//-------------------------------------------------------------------------
	// Public Properties
	//-------------------------------------------------------------------------
	
	public var charCode : Number;
	public var ctrlKey : Boolean;
	public var keyCode : Number;
	public var shiftKey : Boolean;
	
	
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
	
	/**
	 * Constructor
	 */
	public function KeyboardEvent( type : EventType, source )
	{
		super( type, source );
		
		charCode = Key.getAscii();
		ctrlKey = Key.isDown( Key.CONTROL );
		keyCode = Key.getCode();
		shiftKey = Key.isDown( Key.SHIFT );
	}
	
	/**
	 * Returns clone instance
	 */
	public function clone() : KeyboardEvent
	{
		var e : KeyboardEvent = new KeyboardEvent( _e, _oT );
		e.charCode = charCode;
		e.ctrlKey = ctrlKey;
		e.keyCode = keyCode;
		e.shiftKey = shiftKey;
		return e;
	}

}