Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
StringUtil

Package | mx.utils
Class | public class StringUtil
Inheritance | StringUtil Object

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The StringUtil utility class is an all-static class with methods for working with String objects within Flex. You do not create instances of StringUtil; instead you call methods such as the `StringUtil.substitute()` method.

Public Methods

| Method | Defined By
--- | --- | ---
|  | isWhitespace(character:String):Boolean [static] Returns true if the specified string is a single space, tab, carriage return, newline, or formfeed character. | StringUtil
|  | repeat(str:String, n:int):String [static] Returns a string consisting of a specified string concatenated with itself a specified number of times. | StringUtil
|  | restrict(str:String, restrict:String):String [static] Removes "unallowed" characters from a string. | StringUtil
|  | substitute(str:String, ... rest):String [static] Substitutes "{n}" tokens within the specified string with the respective arguments passed in. | StringUtil
|  | trim(str:String):String [static] Removes all whitespace characters from the beginning and end of the specified string. | StringUtil
|  | trimArrayElements(value:String, delimiter:String):String [static] Removes all whitespace characters from the beginning and end of each element in an Array, where the Array is stored as a String. | StringUtil

Method Detail

isWhitespace | () | method

`public static function isWhitespace(character:String):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

repeat | () | method |

`public static function repeat(str:String, n:int):String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.1

Runtime Versions : | Flash Player 10, AIR 1.5

Returns a string consisting of a specified string concatenated with itself a specified number of times.

Parameters

| `str:String` — The string to be repeated.
| `n:int` — The repeat count.

Returns

| `String` — The repeated string.

restrict | () | method |

`public static function restrict(str:String, restrict:String):String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.1

Runtime Versions : | Flash Player 10, AIR 1.5

Removes "unallowed" characters from a string. A "restriction string" such as `"A-Z0-9"` is used to specify which characters are allowed. This method uses the same logic as the `restrict` property of TextField.

Parameters

| `str:String` — The input string.
| `restrict:String` — The restriction string.

Returns

| `String` — The input string, minus any characters that are not allowed by the restriction string.

substitute | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Substitutes "{n}" tokens within the specified string with the respective arguments passed in. Note that this uses String.replace and "$" can have special meaning in the argument strings escape by using "$$".

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.

trim | () | method |

`public static function trim(str:String):String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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.

trimArrayElements | () | method |

`public static function trimArrayElements(value:String, delimiter:String):String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Removes all whitespace characters from the beginning and end of each element in an Array, where the Array is stored as a String.

Parameters

| `value:String` — The String whose whitespace should be trimmed.
| `delimiter:String` — The String that delimits each Array element in the string.

Returns

| `String` — Updated String where whitespace was removed from the beginning and end of each element.

Sun Mar 5 2017, 03:42 PM +11:00