com.smartclient.debug.public.sc.client.language.String.js Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartgwt Show documentation
Show all versions of smartgwt Show documentation
SmartGWT - GWT API's for SmartClient
The newest version!
/*
* Isomorphic SmartClient
* Version SC_SNAPSHOT-2011-08-08 (2011-08-08)
* Copyright(c) 1998 and beyond Isomorphic Software, Inc. All rights reserved.
* "SmartClient" is a trademark of Isomorphic Software, Inc.
*
* [email protected]
*
* http://smartclient.com/license
*/
//>DEBUG
// This lets us label methods with a name within addMethods
String.prototype.Class = "String";
//
// This prevents HTML-special characters like < and > from being interpreted as tags, and
// preserves line breaks and extra spacing.
//
// converts to
// -------- ---------------------------
// & &
// < <
// > >
// \r,\n,\r\n1space
// \r,\n,\r\n
// \t
// 2 spaces 1space
//
//
// @group stringProcessing
// @return (string) string of HTML with tags in the original HTML escaped.
//<
asHTML : function (noAutoWrap) {
var s = this.replace(/&/g, "&")
.replace(//g,">")
// if we don't do this, we lose the leading space after a crlf because all
// browsers except IE in compat (non-standards) mode treat a
followed by a
// space as just a
(the space is ignored)
.replace(/(\r\n|\r|\n) /g,"
")
.replace(/(\r\n|\r|\n)/g,"
")
.replace(/\t/g," ");
// in autoWrap mode, replace two spaces with a space and an to preserve wrapping to
// the maximum extent possible
return (noAutoWrap ? s.replace(/ /g, " ") : s.replace(/ /g, " "));
},
// revereses asHTML()
unescapeHTML : function () {
// Note: in asHTML() we turn tabs into four , this reversal is lossy in that it turns
// those into four spaces - but we really have no way of knowing whether there were four
// spaces there before or a tab.
return this.replace(/ /g, " ")
.replace(/
/gi, "\n")
.replace(/>/g, ">")
.replace(/</g, "<")
.replace(/&/g, "&");
},
//> @method string.toInitialCaps()
// Convert A String To Initial Caps
// @group stringProcessing
//
// @return (string) converted string
//<
toInitialCaps : function () {
// lowercase the entire thing, then split by spaces
var it = this.toLowerCase().split(" ");
// for each word
for (var i = 0; i < it.length; i++) {
// uppercase the first letter, then add the rest (already lower case)
it[i] = it[i].substring(0,1).toLocaleUpperCase() + it[i].substring(1);
}
return it.join(" ");
},
//> @method string.evalDynamicString()
// Look for ${expressions} in a string and evaluate them. To escape, prepend a
// backslash to the dollar sign. Note that in the event that you actually want
// to display \${ you will have to escape the backslash as follows: \\${. Note
// also that if you're writing this in a JS string you must escape the backslash
// again.
// @group dynamicString
//
// @return (string) converted string
//<
evalDynamicString : function (target, evalVars) {
// must toString() - otherwise strange object literal with slots is returned
if (this.indexOf("${") < 0) return this.toString();
var str = this, lastStart, start, end, evalBlock;
// hand-coded for performance
var accum = isc.StringBuffer.create();
while ((start = str.indexOf("${")) != -1) {
end = str.indexOf("}", start + 1);
if (end == -1) break;
// handle escapes
if (str.charAt(start - 1) == '\\') {
accum.append(str.slice(0, start - 1), str.slice(start, end + 1));
str = str.substring(end + 1, str.length);
continue;
}
var evalBlock = str.slice(start + 2, end);
var evalResult;
if (evalVars != null && evalVars[evalBlock]) {
// shortcut to avoid evalWithVars, which creates a Function each time
evalResult = evalVars[evalBlock];
} else {
try {
evalResult = isc.Class.evalWithVars(evalBlock, evalVars, target);
} catch (e) {
// if a target has been supplied, use that for the log report
var logTarget = target ? target : isc.Log;
logTarget.logWarn("dynamicContents eval error - returning empty string for block -->${"
+ evalBlock + "}<-- error was: " + isc.Log.echo(e));
evalResult = isc.emptyString;
}
}
accum.append(str.slice(0, start), evalResult);
str = str.substring(end + 1, str.length);
}
accum.append(str);
str = accum.toString();
return str;
},
//> @method string.asSource() (A)
// Return a new String that, evaluated as source code, would produce this String's value.
// @group stringProcessing
//
// @return (string) new string
//<
asSource : function (singleQuote) {
return String.asSource(this, singleQuote);
},
// String.cssToCamelCaps()
// Converts a string in css dash syntax "foo-bar-baz" to camelCaps syntax "fooBarBaz".
// Non-alphabetic chars between the '-' and the lowercase letter are ignored,
// eg, 'test-234foo' -> 'test234Foo'.
cssToCamelCaps : function () {
return this.replace(/-([^a-z]*)([a-z])/g,
function (str, p1, p2, offset, s) { return p1 + p2.toUpperCase(); });
}
});
isc.addMethods(String, {
//> @classMethod String.asSource()
// Static method to return a new String that, evaluated as source code, would produce
// the passed in String's value.
// @group dynamicString
// @param string (string) string to convert
// @return (string) converted string
//<
asSource : function (string, singleQuote) {
if (!isc.isA.String(string)) string = ""+string;
var quoteRegex = singleQuote ? String._singleQuoteRegex : String._doubleQuoteRegex,
outerQuote = singleQuote ? "'" : '"';
return outerQuote +
string.replace(/\\/g, "\\\\")
// quote whichever quote we use on the outside
.replace(quoteRegex, '\\' + outerQuote)
.replace(/\t/g, "\\t")
.replace(/\r/g, "\\r")
.replace(/\n/g, "\\n") + outerQuote;
}
});
isc.addMethods(isc, {
// isc.replaceAll() [string helper]
// Replace all occurances of 'find' string with 'replacement' string.
// Uses a native method so is very efficient (and easier to use than grep).
replaceAll : function (source, find, replacement) {
return source.split(find).join(replacement);
},
// isc.contains() [string helper]
// Returns true if this string contains the specified substring.
contains : function (string1, substring) {
if (string1 == null) return false;
return string1.indexOf(substring) > -1
},
// isc.startsWith() [string helper]
// Returns true if this string starts with another string.
startsWith : function (string1, substring) {
if (string1 == null) return false;
return (string1.lastIndexOf(substring, 0) == 0);
},
// isc.endsWith() [string helper]
// Returns true if this string ends with another string.
endsWith : function (string1, substring) {
if (string1 == null) return false;
var startPos = string1.length - substring.length;
if (startPos < 0) return false; // substring longer than main string
return (string1.indexOf(substring, startPos) == startPos);
},
// escapes special characters in XML values - so called 'unparsed data'
// " -> "
// ' -> '
// & -> &
// < -> <
// > -> >
// \r -> &x000D;
//
// NOTE: in an XHTML document, this is baseline functionality.
//
// NOTE: leave this function at the end of the file because the quotes within regex's hose the
// obfuscator, causing it to continue to end of file
makeXMLSafe : function (string) {
if (string == null) return isc.emptyString;
else if (!isc.isA.String(string)) string = string.toString();
return string.replace(/&/g, "&").
replace(//g, ">").
replace(String._doubleQuoteRegex, """).
replace(String._singleQuoteRegex, "'").
replace(/\r/, "
")
;
},
makeCDATA : function (string) {
return "/, "]]")+"]]>";
}
});