/* --------------------------------
** FUNCTION:
**   fnIsPalindromeString 
** DESCRIPTION:
**   This function tests whether a string is a
**   'palindrome' meaning that it is an identical
**   string when reversed
** DEPENDENCIES:
**   fnReverseString
**   fnTrimSpaceFromString
**   fnStripLeadingSpaceFromString
**   fnStripTrailingSpaceFromString
** SEE ALSO:
** DATE:
** 
   -------------------------------- */

function fnIsPalindromeString(sString, bTrimSpace, bIgnoreCase) 
{
  //-->-->-->-->-->-->-->-->-->-->-->-->
  //-- should be an ignore case parameter

  if (bIgnoreCase == null)
    { bIgnoreCase = true; }

  if (bTrimSpace == null)
    { bTrimSpace = true; }

  if (sString == null)
  {
    //-->-->-->-->-->-->-->-->-->-->-->-->
    //-- write out some nasty error message
    //-- somewhere, mortally insulting the programmer
    //-- for such a ridiculous error
    return -1;
  }

  var sTest1 = sString;
  var sTest2 = sString;

  if (bIgnoreCase == true)
  {
    sTest1 = sTest1.toLowerCase();
    sTest2 = sTest2.toLowerCase();
  }

  if (bTrimSpace == true)
  {
    sTest1 = fnTrimSpaceFromString(sTest1);
    sTest2 = fnTrimSpaceFromString(sTest2);
  }

  sTest1 = fnReverseString(sTest2);
  //alert("sTest1 = " + sTest1);
  //alert("sTest2 = " + sTest2);

  if (sTest1 == sTest2)
    { return true; }
  else
    { return false; }

} //-- fnIsPalindromeString()