Class PTStringUtil

Object
   |
   +--PTStringUtil

class PTStringUtil

Static class containing String utility methods.

Usage:	
 	PTStringUtil.trimWhitespace(str)
 

Field Detail

VERSION

<static> Object VERSION

PTStringUtil

PTStringUtil()

PTStringUtil static object constructor

Returns:
New PTStringUtil object. Author Legacy Code

containsAngleBrackets

<static> Boolean containsAngleBrackets(str)

Determines if a string contains angle brackets

Parameters:
str - String to test

Returns:
true if the String contains the '<' or '>' characters.

containsWhitespace

<static> Boolean containsWhitespace(str)

Determines if a string contains whitespace

Parameters:
str - String to test

encodeURL

<static> String encodeURL(str,URLEncodeSingleQuotes)

Escapes a string for safe usage as a URL

Parameters:
str - String to escape (string)
URLEncodeSingleQuotes - Whether or not to also URL encode single quotes (boolean)

Returns:
a URL encoded String

escapeHTML

<static> String escapeHTML(str,doLineBreakConversion,doWhitespaceConversion)

Escapes a string for safe display within HTML

Parameters:
str - String to escape (string)
doLineBreakConversion - (boolean)
doWhitespaceConversion - (boolean)

Returns:
an HTML-escaped String

escapeJS

<static> String escapeJS(str)

Escapes a string for safe usage within JavaScript

Parameters:
str - String to escape (string)

Returns:
a JavaScript-escaped String

getInnerText

<static> String getInnerText(elem)

Retrieves the "innerText" from an element

Parameters:
elem - Element to retrieve innerText from (HTMLElement)

Returns:
text characters inside an element

isAllWhitespace

<static> Boolean isAllWhitespace(str)

Determines if a string contains only whitespace

Parameters:
str - String to test

isString

<static> Boolean isString(obj)

Determines if an object is a string

Parameters:
obj - Object to test

Returns:
true if the object is a String

isValidHTTPString

<static> Boolean isValidHTTPString(str)

Determines if an object is a valid HTTP string

Parameters:
str - String to test

Returns:
true if the String represents an HTTP URL

isValidUNCString

<static> Boolean isValidUNCString(str, bCanBeNull)

Determines if an object is a valid UNC string

Parameters:
str - String to test
bCanBeNull - Whether or not to allow null strings

Returns:
true if the String is a valid UNC path

removeHTML

<static> String removeHTML(str)

Removes HTML from a string of HTML. This method may fail if the text input is HTML wrapped inside of JavaScript or some other deviation from plain-vanilla HTML.

Parameters:
str - String to remove html from (string)

Returns:
a String stripped of HTML tags

stripChars

<static> String stripChars(str,chars)

Removes all occurences of a list of characters from a string

Parameters:
str - String to strip (string)
chars - Array of characters to remove (Array)

trimWhitespace

<static> String trimWhitespace(str,trimFront,trimRear)

Removes whitespace from the beginning and/or end of a string

Parameters:
str - String to trim (string)
trimFront - Option to remove whitespace from front of string (boolean)
trimRear - Option to remove whitespace from tail of string (boolean)

UCFirst

<static> String UCFirst(str)

Converts first letter of a string to upper case

Parameters:
str - String to convert (string)

Returns:
a specially-cased String

unescapeHTML

<static> String unescapeHTML(str)

Unescapes an escaped string for use as HTML

Parameters:
str - String to escape (string)

Returns:
an unescaped HTML String