StringTools  - AS3

The name of the actual locale ID used by this StringTools object.

There are three possibilities for the value of the name, depending on operating system and the value of the requestedLocaleIDName parameter passed to the StringTools() constructor.

1. If the requested locale was not LocaleID.DEFAULT and the operating system provides support for the requested locale, then the name returned is the same as the requestedLocaleIDName property.
2. If LocaleID.DEFAULT was used as the value for the requestedLocaleIDName parameter to the constructor, then the name of the current locale specified by the user's operating system is used. The LocaleID.DEFAULT value preserves user's customized setting in the OS. Passing an explicit value as the requestedLocaleIDName parameter does not necessarily give the same result as using the LocaleID.DEFAULT even if the two locale ID names are the same. The user could have customized the locale settings on the machine, and by requesting an explicit locale ID name rather than using LocaleID.DEFAULT your application would not retrieve those customized settings.
3. If the system does not support the requestedLocaleIDName specified in the constructor then a fallback locale ID name is provided.

Related API Elements

The status of the most recent operation that this StringTools object performed. The lastOperationStatus property is set whenever the constructor or a method of this class is called or another property is set. For the possible values see the description for each method.

Related API Elements

The name of the requested locale ID that was passed to the constructor of this StringTools object.

If the LocaleID.DEFAULT value was used then the name returned is "i-default". The actual locale used can differ from the requested locale when a fallback locale is applied. The name of the actual locale can be retrieved using the actualLocaleIDName property.

Related API Elements

Constructs a new StringTools object that provides case conversion and other utilities according to the conventions of a given locale.

This constructor determines if the current operating system supports the requested locale ID name. If it is not supported then a fallback locale is used instead. If a fallback locale is used then the lastOperationStatus property indicates the type of fallback, and the actualLocaleIDName property contains the name of the fallback locale ID.

When this constructor completes successfully the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

When the requested locale ID name is not available then the lastOperationStatus is set to one of the following:

• LastOperationStatus.USING_FALLBACK_WARNING
• LastOperationStatus.USING_DEFAULT_WARNING

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

Related API Elements

Lists all of the locale ID names supported by this class.

If this class is not supported on the current operating system, this method returns a null value.

When this method is called and it completes successfully, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

Converts a string to lowercase according to language conventions. Depending on the locale, the output string length can differ from the input string length.

When this method is called and it completes successfully, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

Parameters

Related API Elements

Converts a string to uppercase according to language conventions. Depending on the locale, the output string length can differ from the input string length.

When this method is called and it completes successfully, the lastOperationStatus property is set to:

• LastOperationStatus.NO_ERROR

Otherwise the lastOperationStatus property is set to one of the constants defined in the LastOperationStatus class.

Parameters

Related API Elements

This example takes the following steps:

1. Creates a StringTools object.
2. Defines three strings with characters unique to the Turkish, Greek, and German languages.
3. Converts each string to upper case and lower case and displays the results. This example demonstrates interesting locale-specific behavior for characters like the Turkish "ı" and "İ", the German "ß" and the Greek "Σςσ".

package {
    import flash.display.Sprite;
    import flash.globalization.LocaleID;
    import flash.globalization.StringTools;
    import flash.text.TextField;
    import flash.text.TextFieldAutoSize;

    public class StringToolsExample extends Sprite
    {
        public function StringToolsExample()
        {
            var localeName:String= LocaleID.DEFAULT;
            var strTool:StringTools = new StringTools(localeName);
            
            trace('\n\n' + "LocaleID requested: " + nf.requestedLocaleIDName 
            + "; actual: " + nf.actualLocaleIDName);
            trace( "Last Operation Status:" + nf.lastOperationStatus );  
            
            var turkishStr:String = "iI ıİ";
            var greekStr:String = "Σςσβΰ�Σ";
            var germanStr:String= "ß";
            
            var tfTurInp:TextField = createTextField(10, 10);
            tfTurInp.text="Turkish Input: \t " + turkishStr;
            
            var tfdash:TextField = createTextField(10, 20);
            tfdash.text="-------------------";
            
            var tf1:TextField = createTextField(10, 30);
            tf1.text="\t Upper case: \t " + strTool.toUpperCase(turkishStr);
            
            var tf2:TextField = createTextField(10, 40);
            tf2.text="\t Lower case: \t " + strTool.toLowerCase(turkishStr);
            
            var tfgreekInp:TextField = createTextField(10, 60);
            tfgreekInp.text="Greek Input: \t " + greekStr;
            
            var tfdash1:TextField = createTextField(10, 70);
            tfdash1.text="-------------------";
            
            var tf3:TextField = createTextField(10, 80);
            tf3.text="\t Upper case: \t " + strTool.toUpperCase(greekStr);
            
            var tf4:TextField = createTextField(10, 90);
            tf4.text="\t Lower case: \t " + strTool.toLowerCase(greekStr);
            
            var tfgermanInp:TextField = createTextField(10, 110);
            tfgermanInp.text="German Input: \t " + germanStr;
            
            var tfdash2:TextField = createTextField(10, 120);
            tfdash2.text="-------------------";
                         
            var tf5:TextField = createTextField(10, 130);
            tf5.text="\t Upper case: \t " + strTool.toUpperCase(germanStr);
            
            var tf6:TextField = createTextField(10, 140);
            tf6.text="\t Lower case: \t " + strTool.toLowerCase(germanStr);
        }
        
        private function createTextField(x:Number, y:Number):TextField 
        {
            var result:TextField = new TextField();
            result.x = x;
            result.y = y;
            result.autoSize=TextFieldAutoSize.LEFT;
            addChild(result);
            return result;
        }
    }
}