TextFieldUtils

/*
Copyright 2005-2006 by the authors of asapframework, http://asapframework.org

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

class playground.classes.util.TextFieldUtils {

    private static var MAGICAL_TEXTWIDTH_PADDING:Number = 3;

    /**
    Trims the text to fit a given textfield.
    @param inTextField : the TextField to set the new text to
    @param inTextWidth : the maximum width of the text in pixels
    @param inAbbreviatedString : the text that indicates that trimming has occurred; commonly this is "..."
    */
    public static function trimTextFieldText (inTextField:TextField,
                                              inTextWidth:Number,
                                              inAbbreviatedString:String) : Void {
        var text:String = inTextField.text;
        var abbr:String = (inAbbreviatedString != undefined) ? inAbbreviatedString : "";
        var trimLength:Number = text.length;
        while ((inTextField.textWidth + MAGICAL_TEXTWIDTH_PADDING) > inTextWidth && trimLength >= abbr.length) {
            trimLength -= 1;
            text = text.substr(0, trimLength);
            text += abbr;
            inTextField.text = text;
        }
    }
}