Class String

Object
   |
   +--String

class String

Defined in prototype.js

Field Detail

evalScriptsComplete

Object evalScriptsComplete

__parseStyleElement

<static> Object __parseStyleElement

String

String()

blank

void blank()

camelize

Object camelize()

capitalize

Object capitalize()

dasherize

Object dasherize()

empty

void empty(element)

endsWith

Object endsWith(pattern)

escapeHTML

Object escapeHTML()

escapeHTMLAttr

Object escapeHTMLAttr()

Escapes <,>,&,\',\".

Returns:
String escaped for HTML attribute values.

escapeJS

Object escapeJS()

Escapes \',\",\\,\n,\r.

Returns:
String escaped for JS within HTML.

escapeRegExp

Object escapeRegExp()

Escapes regular expression characters in this string.

Returns:
String escaped for use by new RegExp().

evalJSON

Object evalJSON(sanitize)

evalScripts

Object evalScripts()

extractScripts

Object extractScripts()

formatMessage

Object formatMessage(params)

Formats this string with message parameters. For example, "{0} is hella {1}!".formatMessage(["Cartman", "cool"]) returns "Cartman is hella cool!".

Parameters:
params - Array of parameters.

Returns:
Formatted message.

go

void go()

Go to this url.

gsub

Object gsub(pattern, replacement)

include

Object include(pattern)

inspect

Object inspect(useDoubleQuotes)

interpolate

Object interpolate(object, pattern)

isJSON

Object isJSON()

parseColor

Object parseColor()

parseDate

Object parseDate(pattern)

Parses date by pattern as defined by java.text.SimpleDateFormat. Uses CAF.serverTimezoneOffset to calculate localalized time.

Parameters:
pattern - Pattern with which to parse (ex: 'EEEEE, MMMMM d, yyyy').

Returns:
new Date

See:
- java.text.SimpleDateFormat for pattern documentation.
Throws:
- Date.ParseError if string cannot be parsed.

parseQuery

Object parseQuery(separator)

parseRFC3339Date

Object parseRFC3339Date()

Parses date using RFC 3339 format.

Returns:
Parsed date or null.

Throws:
- Error if null.

parseStyle

Object parseStyle()

replaceQueryParams

Object replaceQueryParams(params)

Adds, replaces, or removes the specified url query params from this string. For each specified param, if the param doesn't already exist in this string, the param is added; if the param does already exist in the string, the existing param value is replaced; if the param does already exist and the value to replace is null, the param is removed. For example, "/foo?a=b&c=d&e=f#bar".replaceQueryParams({ a:"x", b:"y", c:null }) returns "/foo?a=x&b=y&e=f#bar".

Parameters:
params - Map of (unencoded) params to replace.

Returns:
New string with updated params.

scan

Object scan(pattern, iterator)

startsWith

Object startsWith(pattern)

strip

void strip()

stripExternalScripts

Object stripExternalScripts()

Strips external scripts from string.

Returns:
String without external scripts.

stripScripts

Object stripScripts()

stripTags

Object stripTags()

sub

Object sub(pattern, replacement, count)

succ

Object succ()

times

Object times(count)

toArray

Object toArray()

toQueryParams

Object toQueryParams(separator)

trim

Object trim()

Trims leading and trailing whitespace from string.

Returns:
String trimmed of its whitespace.

truncate

Object truncate(length, truncation)

underscore

Object underscore()

unescapeHTML

Object unescapeHTML()

unfilterJSON

Object unfilterJSON(filter)

interpret

<static> Object interpret(value)