topical media & game development

topical media & game development

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

student-ar-org-ascollada-utils-StringUtil.ax

student-ar-org-ascollada-utils-StringUtil.ax [swf] flex


  //////////////////////////////////////////////////////////////////////////


  //
  //  Copyright (C) 2003-2007 Adobe Systems Incorporated
  //  All Rights Reserved. The following is Source Code and is subject to all
  //  restrictions on such code as contained in the End User License Agreement
  //  accompanying this product.
  //
  //////////////////////////////////////////////////////////////////////////


  
  package org.ascollada.utils
  {

The @ax-student-ar-org-ascollada-utils-StringUtil utility class is an all-static class with methods for working with String objects within Flex. You do not create instances of @ax-student-ar-org-ascollada-utils-StringUtil; instead you call methods such as the <code>@ax-student-ar-org-ascollada-utils-StringUtil.substitute()</code> method.


  
          public class @ax-student-ar-org-ascollada-utils-StringUtil
          {
              //--------------------------------------------------------------------------
              //
              //  Class methods
              //
              //--------------------------------------------------------------------------

Removes all whitespace characters from the beginning and end of the specified string.
parameter: str The String whose whitespace should be trimmed.
returns: Updated String where whitespace was removed from the beginning and end.


  
              public static function trim(str:String):String
              {
                  var startIndex:int = 0;
                  while (isWhitespace(str.charAt(startIndex)))
                      ++startIndex;
          
                  var endIndex:int = str.length - 1;
                  while (isWhitespace(str.charAt(endIndex)))
                      --endIndex;
          
                  if (endIndex >= startIndex)
                      return str.slice(startIndex, endIndex + 1);
                  else
                      return "";
              }

Removes all whitespace characters from the beginning and end of each element in an Array, where the Array is stored as a String.
parameter: value The String whose whitespace should be trimmed.
parameter: separator The String that delimits each Array element in the string.
returns: Updated String where whitespace was removed from the beginning and end of each element.


  
              public static function trimArrayElements(value:String, delimiter:String):String
              {
                  if (value != "" && value != null)
                  {
                      var items:Array = value.split(delimiter);
                      
                      var len:int = items.length;
                      for (var i:int = 0; i < len; i++)
                      {
                          items[i] = @ax-student-ar-org-ascollada-utils-StringUtil.trim(items[i]);
                      }
                      
                      if (len > 0)
                      {
                          value = items.join(delimiter);
                      }
                  }
                  
                  return value;
              }

Returns <code>true</code> if the specified string is a single space, tab, carriage return, newline, or formfeed character.
parameter: str The String that is is being queried.
returns: true if the specified string is a single space, tab, carriage return, newline, or formfeed character.


  
              public static function isWhitespace(character:String):Boolean
              {
                  switch (character)
                  {
                      case " ":
                      case "\t":
                      case "\r":
                      case "\n":
                      case "\f":
                          return true;
          
                      default:
                          return false;
                  }
              }

Substitutes "{n}" tokens within the specified string with the respective arguments passed in.
parameter: str The string to make substitutions in. This string can contain special tokens of the form <code>{n}</code>, where <code>n</code> is a zero based index, that will be replaced with the additional parameters found at that index if specified.
parameter: rest Additional parameters that can be substituted in the <code>str</code> parameter at each <code>{n}</code> location, where <code>n</code> 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 <pre> public function myTracer(str:String, ... rest):void { label.text += @ax-student-ar-org-ascollada-utils-StringUtil.substitute(str, rest) + "\n"; } </pre>
returns: 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(@ax-student-ar-org-ascollada-utils-StringUtil.substitute(str, 15.4, true)); // this will output the following string: // "here is some info '15.4' and true"


  
              public static function substitute(str:String, ... rest):String
              {
                  // Replace all of the parameters in the msg string.
                  var len:uint = rest.length;
                  var args:Array;
                  if (len == 1 && rest[0] is Array)
                  {
                      args = rest[0] as Array;
                      len = args.length;
                  }
                  else
                  {
                      args = rest;
                  }
                  
                  for (var i:int = 0; i < len; i++)
                  {
                      str = str.replace(new RegExp("\{"+i+"\}", "g"), args[i]);
                  }
          
                  return str;
              }
          }
  
  }

[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.