flash.globalization.StringTools - Adobe® AIR® API Reference for HTML Developers

window.runtime property	window.runtime.flash.globalization.StringTools

Inheritance	StringTools Object

Runtime Versions:

The StringTools class provides locale-sensitive case conversion methods.

In some situations the conversion between uppercase and lowercase letters is not a simple mapping from one character to another and instead requires language- or context-specific processing. For example:

In Turkish and Azeri, the uppercase of the dotted lowercase i is an uppercase dotted İ (U+0130). Similarly the lowercase of a dotless uppercase I, is a lowercase dotless ı (U+0131).
The lowercase sharp S, ß (U+00DF), used in German is converted to uppercase double SS.
In Greek there are two representations of the lowercase sigma, σ (U+03C3) and ς (U+03C2), which both convert to the single uppercase sigma Σ (U+03A3).

The toLowerCase() and toUpperCase() methods of this class provide this special case conversion logic.

Due to the use of the user's settings, the use of case conversion rules provided by the operating system, and the use of a fallback locale when a requested locale is not supported, different users can see different case conversion results even when using the same locale ID.

Properties

Hide Inherited Public Properties

Show Inherited Properties

	Property		Defined By
		actualLocaleIDName : String [read-only] The name of the actual locale ID used by this StringTools object.	StringTools
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		lastOperationStatus : String [read-only] The status of the most recent operation that this StringTools object performed.	StringTools
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		requestedLocaleIDName : String [read-only] The name of the requested locale ID that was passed to the constructor of this StringTools object.	StringTools

Public Methods

Hide Inherited Public Methods

Show Inherited Methods

	Method		Defined By
		StringTools(requestedLocaleIDName:String) Constructs a new StringTools object that provides case conversion and other utilities according to the conventions of a given locale.	StringTools
		getAvailableLocaleIDNames():Vector.<String> [static] Lists all of the locale ID names supported by this class.	StringTools
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toLowerCase(s:String):String Converts a string to lowercase according to language conventions.	StringTools
		toString():String Returns the string representation of the specified object.	Object
		toUpperCase(s:String):String Converts a string to uppercase according to language conventions.	StringTools
		valueOf():Object Returns the primitive value of the specified object.	Object

Property Detail

actualLocaleIDName

property

actualLocaleIDName:String [read-only]

Runtime Versions:

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.

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.
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.
If the system does not support the requestedLocaleIDName specified in the constructor then a fallback locale ID name is provided.

lastOperationStatus

property

lastOperationStatus:String [read-only]

Runtime Versions:

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.

See also

LastOperationStatus

requestedLocaleIDName

property

requestedLocaleIDName:String [read-only]

Runtime Versions:

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.

Constructor Detail

StringTools

()

Constructor

public function StringTools(requestedLocaleIDName:String)

Runtime Versions:

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.

Parameters

requestedLocaleIDName:String — The preferred locale ID name to use when determining date or time formats.

Throws

ArgumentError — when the requestedLocaleIDName parameter is null

See also

LocaleID
lastOperationStatus

Method Detail

getAvailableLocaleIDNames

()

method

public function getAvailableLocaleIDNames():Vector.<String>

Runtime Versions:

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.

Returns

Vector.<String> — A vector of strings containing all of the locale ID names supported by this class.

toLowerCase

()

method

public function toLowerCase(s:String):String

Runtime Versions:

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

s:String — string to convert to lowercase.

Returns

String — The converted lowercase string.

Throws

ArgumentError — when the s parameter is null.

See also

lastOperationStatus
LastOperationStatus

toUpperCase

()

method

public function toUpperCase(s:String):String

Runtime Versions:

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

s:String — string to convert to uppercase.

Returns

String — The converted uppercase string.

Throws

ArgumentError — when the s parameter is null.

See also

lastOperationStatus
LastOperationStatus

[an error occurred while processing this directive][an error occurred while processing this directive]

Legal Notices | Online Privacy Policy