mx.utils.StringUtil (Flex™ 2 Language Reference)

	Property	Defined by
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

	Method		Defined by
		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
		isWhitespace(character:String):Boolean [static] Returns `true` if the specified string is a single space, tab, carriage return, newline, or formfeed character.	StringUtil
		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
		substitute(str:String, ... rest):String [static] Substitutes "{n}" tokens within the specified string with the respective arguments passed in.	StringUtil
		toString():String Returns the string representation of the specified object.	Object
		trim(str:String):String [static] Removes all whitespace characters from the beginning and end of the specified string.	StringUtil
		valueOf():Object Returns the primitive value of the specified object.	Object

Method detail

isWhitespace

()

method

public static function isWhitespace(character:String):Boolean

Returns true if the specified string is a single space, tab, carriage return, newline, or formfeed character.

Parameters

character:String — The String that is is being queried.

Returns

Boolean — true if the specified string is a single space, tab, carriage return, newline, or formfeed character.

substitute

()

method

public static function substitute(str:String, ... rest):String

Substitutes "{n}" tokens within the specified string with the respective arguments passed in.

Parameters

	`str:String` — The string to make substitutions in. This string can contain special tokens of the form `{n}`, where `n` is a zero based index, that will be replaced with the additional parameters found at that index if specified.

	`... rest` — Additional parameters that can be substituted in the `str` parameter at each `{n}` location, where `n` is an integer (zero based) index value into the array of values specified. If the first parameter is an array this array will be used as a parameter list. This allows reuse of this routine in other methods that want to use the ... rest signature. For example public function myTracer(str:String, ... rest):void { label.text += StringUtil.substitute(str, rest) + "\n"; }

Returns

String — New string with all of the {n} tokens replaced with the respective arguments specified.

Example
var str:String = "here is some info '{0}' and {1}"; trace(StringUtil.substitute(str, 15.4, true)); // this will output the following string: // "here is some info '15.4' and true"

trim

()

method

public static function trim(str:String):String

Removes all whitespace characters from the beginning and end of the specified string.

Parameters

str:String — The String whose whitespace should be trimmed.

Returns

String — Updated String where whitespace was removed from the beginning and end.

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class StringUtil	Properties \| Methods

Package	mx.utils
Class	public class StringUtil
Inheritance	StringUtil Object