textLayout_core/src/flashx/textLayout/property/NumberOrPercentProperty.as

////////////////////////////////////////////////////////////////////////////////
//
//  Licensed to the Apache Software Foundation (ASF) under one or more
//  contributor license agreements.  See the NOTICE file distributed with
//  this work for additional information regarding copyright ownership.
//  The ASF licenses this file to You under the Apache License, Version 2.0
//  (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.apache.org/licenses/LICENSE-2.0
//
//  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.
//
////////////////////////////////////////////////////////////////////////////////
package flashx.textLayout.property
{
	import flashx.textLayout.debug.assert;
	import flashx.textLayout.formats.FormatValue;
	import flashx.textLayout.tlf_internal;
		
	use namespace tlf_internal;
	
	[ExcludeClass]
	/** A property description with a Number or a Percent as its value. @private */
	public class NumberOrPercentProperty extends Property
	{
		private var _minNumberValue:Number;
		private var _maxNumberValue:Number;
		private var _minPercentValue:Number;
		private var _maxPercentValue:Number;
		
		/** Value will be a % terminated string or a number */
		public function NumberOrPercentProperty(nameValue:String, defaultValue:Object, inherited:Boolean, category:String, minValue:Number, maxValue:Number, minPercentValue:String, maxPercentValue:String)
		{
			super(nameValue, defaultValue, inherited, category);
			
			// the nested properties don't need the true default
			_minNumberValue = minValue;
			_maxNumberValue = maxValue;
			_minPercentValue = toNumberIfPercent(minPercentValue);
			_maxPercentValue = toNumberIfPercent(maxPercentValue);
		}
		
		public function get minNumberValue():Number
		{ return _minNumberValue; }
		public function get maxNumberValue():Number
		{ return _maxNumberValue; } 
		public function get minPercentValue():Number
		{ return _minPercentValue; }
		public function get maxPercentValue():Number
		{ return _maxPercentValue; }
		
		static private function toNumberIfPercent(o:Object):Number
		{
			if (!(o is String))
				return NaN;
			var s:String = String(o);
			var len:int = s.length;
			
			return len != 0 && s.charAt(len-1) == "%" ? parseFloat(s) : NaN;
		}

		/** @private */
		public override function setHelper(currVal:*,newObject:*):*
		{ 
			if (newObject === null)
				newObject = undefined;
			
			if (newObject === undefined || newObject == FormatValue.INHERIT)
				return newObject;

			var newVal:Number = toNumberIfPercent(newObject);
			if (!isNaN(newVal))
			{
				if (checkLowerLimit() && newVal < _minPercentValue)
				{
					Property.errorHandler(this,newObject);
					return currVal;
				}
				if (checkUpperLimit() && newVal > _maxPercentValue)
				{
					Property.errorHandler(this,newObject);
					return currVal;
				}
				return newVal.toString()+"%";
			}

			newVal = parseFloat(newObject);
			// Nan --> return the current value
			if (isNaN(newVal))
			{
				Property.errorHandler(this,newObject);
				return currVal;
			}
			if (checkLowerLimit() && newVal < _minNumberValue)
			{
				Property.errorHandler(this,newObject);
				return currVal;
			}
			if (checkUpperLimit() && newVal > _maxNumberValue)
			{
				Property.errorHandler(this,newObject);
				return currVal;
			}
			return newVal;
		}
		
		/** @private */
		public override function hash(val:Object, seed:uint):uint
		{ 
			if (val == FormatValue.INHERIT)
				return UintProperty.doHash(inheritHashValue, seed);
			if (val is String)
				return StringProperty.doHash(String(val), seed);
			return NumberProperty.doHash(val as Number, seed);
		}
		
		public function computeActualPropertyValue(propertyValue:Object,percentInput:Number):Number
		{
			var percent:Number = toNumberIfPercent(propertyValue);
			if (isNaN(percent))
				return Number(propertyValue);
				
			// its a percent - calculate and clamp
			var rslt:Number =  percentInput * (percent / 100);
			if (rslt < _minNumberValue)
				return _minNumberValue;
			if (rslt > _maxNumberValue)
				return _maxNumberValue;
			return rslt;			
		}
	}
}