/*-----------------------------------------------------------------------------
	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.
-----------------------------------------------------------------------------*/

/**
 * Client's screen properties.
 * 
 * <p>Take a look at {@link fever.core.client.ClientContext} to see example.
 * 
 * @see fever.core.client.ClientContext#screen
 * 
 * @author Romain Ecarnot
 */
class fever.core.client.ClientScreen
{
	//-------------------------------------------------------------------------
	// Public Properties
	//-------------------------------------------------------------------------
	
	/** 
	 * A string that indicates the screen color. 
	 * This property can have the value "color", "gray" or "bw", 
	 * which represents color, grayscale, and black and white, respectively. 
	 */
	public function get color () : String { return System.capabilities.screenColor; }
	
	/**
	 * A number that indicates the dots-per-inch (dpi) resolution of the 
	 * screen in pixels.
	 */
	public function get dpi () : Number { return System.capabilities.screenDPI; }
	
	/**
	 * An integer that indicates the maximum horizontal resolution of the 
	 * screen.
	 */
	public function get width () : Number { return System.capabilities.screenResolutionX; }
	
	/**
	 * An integer that indicates the maximum vertical resolution of the 
	 * screen.
	 */
	public function get height () : Number { return System.capabilities.screenResolutionY; }
	
	/**
	 * The current display refresh rate in Hertz (Hz).
	 * 
	 * <p>Flash doesn't know about this property in many context ( Flash player, browser ) but 
	 * know it on SWF Studio, mProjector, Zinc etc...
	 */
	public function get refreshRate() : Number { return null; }
	
	
	//-------------------------------------------------------------------------
	// Public implementation
	//-------------------------------------------------------------------------
	
	/**
	 * Constructor.
	 */
	public function ClientScreen()
	{
	
	}
	
	/**
	 * Returns string representation
	 */
	public function toString() : String
	{
		return ( width + "x" + height + " in '" + color + "' mode" ); 
	}	
}