JX(Javascript Extend Tools) 1.0 API 开发参考文档
站在巨人的肩上 Standing on shoulders of giants

View on Github

命名空间 string


Defined in: jx.string.js.

命名空间 概要
Constructor Attributes Constructor Name and Description
 
string
string 名字空间
属性概要
Field Attributes Field Name and Description
<static>  
string.template
多行或单行字符串模板处理
方法概要
Method Attributes Method Name and Description
<static>  
string.buildURL(obj)
将一个对象（成员为：scheme, user, pass, host, port, path, query, fragment）重新组成为一个字符串
<static>  
string.byteLength(string, n)
计算字符串的字节长度
<static>  
string.camelCase(string)
将“-”连接的字符串转换成驼峰式写法
<static>  
string.capitalize(string)
将字符串转换成全大写字母
<static>  
string.clean(string)
清除字符串开头和结尾的空格，并把字符串之间的多个空格转换为一个空格
<static>  
string.contains(string, separator)
判断是否含有指定的字符串
<static>  
string.cutByBytes(string, n)
按字节按给定长度裁剪给定字符串
<static>  
string.cutByWidth(str, fontsize, width)
按给定宽度裁剪字符串
<static>  
string.cutRight(string, n)
按字符按给定长度裁剪给定字符串
<static>  
string.decodeHtmlSimple(sStr)
html正文解码, 对HtmlEncode函数的结果进行解码
<static>  
string.encodeHrefScript(sStr)
用做过滤直接放到中的
<static>  
string.encodeHtml(sStr)
用做过滤直接放到HTML里的
<static>  
string.encodeHtmlAttribute(sStr)
用做过滤HTML标签里面的东东 比如这个例子里的<input value="XXXX"> XXXX就是要过滤的
<static>  
string.encodeHtmlAttributeSimple(sStr)
html属性编码：对需要出现在HTML属性里的不信任输入进行编码 注意: (1)该函数不适用于属性为一个URL地址的编码.
<static>  
string.encodeHtmlSimple(sStr)
html正文编码, 对需要出现在HTML正文里(除了HTML属性外)的不信任输入进行编码
<static>  
string.encodeRegExp(sStr)
用做过滤直接放到正则表达式中的
<static>  
string.encodeScript(sStr)
用做过滤直接放到HTML里js中的
<static>  
string.encodeUriComponent(sStr)
对需要出现在一个URI的一部分的不信任输入进行编码 例如: Click Here! 以下字符将会被编码: 除[a-zA-Z0-9.
<static>  
string.encodeUrl(sStr)
用做过滤直接URL参数里的 比如 http://show8.qq.com/abc_cgi?a=XXX XXX就是要过滤的
<static>  
string.escapeRegExp(string)
转换 RegExp 正则表达式
<static>  
string.getCharWidth(str, fontsize)
获取字符实际宽度
<static>  
string.hexToRgb(string, array)
将颜色 Hex 写法转换成 RGB 写法
<static>  
string.hyphenate(string)
将驼峰式写法字符串转换成“-”连接的
<static>  
string.isEmail(emailStr)
判断一个字符串是否是邮箱格式
<static>  
string.isNumber(string, n)
判断给定字符串是否是数字
<static>  
string.isURL(str)
判断是否是一个可接受的 url 串
<static>  
string.mapQuery(uri)
将 uri 的查询字符串参数映射成对象
<static>  
string.parseURL(str)
分解 URL 为一个对象，成员为：scheme, user, pass, host, port, path, query, fragment
<static>  
string.replaceAll(string, reallyDo, replaceWith, ignoreCase)
全局替换指定的字符串
<static>  
string.rgbToHex(string, array)
将颜色 RGB 写法转换成 Hex 写法
<static>  
string.stripScripts(string, option)
脱去script标签
<static>  
string.substitute(string, object, regexp)
。。。。
<static>  
string.test(regex, params, params)
test的方法
<static>  
string.toFloat(string)
将字符串转换成浮点数
<static>  
string.toHtml(str)
将字符串转换成html源码
<static>  
string.toInt(string, base)
将字符串转换成整数
<static>  
string.toQueryPair(obj, value)
。。。。
<static>  
string.toQueryString(obj)
。。。。
<static>  
string.toSingleLine(str)
将带换行符的字符串转换成无换行符的字符串
<static>  
string.toString(o)
将任意变量转换为字符串的方法
<static>  
string.toTitle(str)
将字符串转换成用于title的字符串
<static>  
string.trim(string)
清除字符串开头和结尾的空格
<static>  
string.vaildTencentUrl(sUrl)
url转向验证 描述：对通过javascript语句载入（或转向）的页面进行验证，防止转到第三方网页和跨站脚本攻击 返回值：true -- 合法；false -- 非法 例： 合法的值 http://xxx.qq.com/hi/redirect.html?url=http://www.qq.com http://xxx.qq.com/hi/redirect.html?url=a.html http://xxx.qq.com/hi/redirect.html?url=/a/1.html 非法的值 http://xxx.qq.com/hi/redirect.html?url=http://www.baidu.com http://xxx.qq.com/hi/redirect.html?url=javascript:codehere http://xxx.qq.com/hi/redirect.html?url=//www.qq.com
<static>  
string.vaildUrl(sUrl)
验证给定字符串是否是url, 如果是url 则返回正常的url
命名空间 详解
string
功能:
string 名字空间
属性详解
<static> {String} string.template
多行或单行字符串模板处理 


Jx().$package(function(J){
 // 用 obj 对象的数据合并到字符串模板中
 J.template("Hello, {name}!", {
     name:"Kinvix"
 });
};
方法详解
<static> {String} string.buildURL(obj)
功能:
将一个对象（成员为：scheme, user, pass, host, port, path, query, fragment）重新组成为一个字符串
参数:
{Object} obj
URl 对象
返回:
{String} 如果是可接受的 url 则返回 true
<static> {Number} string.byteLength(string, n)
功能:
计算字符串的字节长度
参数:
{String} string
{Number} n
指定一个中文的字节数, 默认为2
返回:
{Number} 返回自己长度
<static> {String} string.camelCase(string)
功能:
将“-”连接的字符串转换成驼峰式写法
参数:
string
返回:
{String} 返回转换后的字符串
<static> {String} string.capitalize(string)
功能:
将字符串转换成全大写字母
参数:
string
返回:
{String} 返回转换后的字符串
<static> {String} string.clean(string)
功能:
清除字符串开头和结尾的空格，并把字符串之间的多个空格转换为一个空格
参数:
string
返回:
{String} 返回清除后的字符串
<static> {Boolean} string.contains(string, separator)
功能:
判断是否含有指定的字符串
参数:
{String} string
是否含有的字符串
{String} separator
分隔符，可选
返回:
{Boolean} 如果含有，返回 true，否则返回 false
<static> {String} string.cutByBytes(string, n)
功能:
按字节按给定长度裁剪给定字符串
参数:
{String} string
{Number} n
返回:
{String}
<static> {Number} string.cutByWidth(str, fontsize, width)
功能:
按给定宽度裁剪字符串
参数:
{String} str
{Number} fontsize
字体大小
{Number} width
限定的宽度
返回:
{Number}
<static> {String} string.cutRight(string, n)
功能:
按字符按给定长度裁剪给定字符串
参数:
{String} string
{Number} n
返回:
{String}
<static> {String} string.decodeHtmlSimple(sStr)
功能:
html正文解码, 对HtmlEncode函数的结果进行解码
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeHrefScript(sStr)
功能:
用做过滤直接放到中的
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeHtml(sStr)
功能:
用做过滤直接放到HTML里的
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeHtmlAttribute(sStr)
功能:
用做过滤HTML标签里面的东东 比如这个例子里的<input value="XXXX"> XXXX就是要过滤的
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeHtmlAttributeSimple(sStr)
功能:
html属性编码：对需要出现在HTML属性里的不信任输入进行编码 注意: (1)该函数不适用于属性为一个URL地址的编码.这些标记包括:a/img/frame/iframe/script/xml/embed/object... 属性包括:href/src/lowsrc/dynsrc/background/... (2)该函数不适用于属性名为 style="[Un-trusted input]" 的编码
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeHtmlSimple(sStr)
功能:
html正文编码, 对需要出现在HTML正文里(除了HTML属性外)的不信任输入进行编码
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeRegExp(sStr)
功能:
用做过滤直接放到正则表达式中的
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeScript(sStr)
功能:
用做过滤直接放到HTML里js中的
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeUriComponent(sStr)
功能:
对需要出现在一个URI的一部分的不信任输入进行编码 例如: Click Here! 以下字符将会被编码: 除[a-zA-Z0-9.-_]以外的字符都会被替换成URL编码
参数:
{String} sStr
返回:
{String}
<static> {String} string.encodeUrl(sStr)
功能:
用做过滤直接URL参数里的 比如 http://show8.qq.com/abc_cgi?a=XXX XXX就是要过滤的
参数:
{String} sStr
返回:
{String}
<static> {String} string.escapeRegExp(string)
功能:
转换 RegExp 正则表达式
参数:
string
返回:
{String} 返回转换后的字符串
<static> {Number} string.getCharWidth(str, fontsize)
功能:
获取字符实际宽度
参数:
{String} str
需要计算的字符串
{Number} fontsize
字体大小，可以不填
返回:
{Number}
<static> {String} string.hexToRgb(string, array)
功能:
将颜色 Hex 写法转换成 RGB 写法
参数:
string
array
返回:
{String} 返回转换后的字符串
<static> {String} string.hyphenate(string)
功能:
将驼峰式写法字符串转换成“-”连接的
参数:
string
返回:
{String} 返回转换后的字符串
<static> {Boolean} string.isEmail(emailStr)
功能:
判断一个字符串是否是邮箱格式
参数:
{String} emailStr
返回:
{Boolean}
<static> {String} string.isNumber(string, n)
功能:
判断给定字符串是否是数字
参数:
{String} string
{Number} n
返回:
{String}
<static> {Boolean} string.isURL(str)
功能:
判断是否是一个可接受的 url 串
参数:
{String} str
要检测的字符串
返回:
{Boolean} 如果是可接受的 url 则返回 true
<static> {Object} string.mapQuery(uri)
功能:
将 uri 的查询字符串参数映射成对象 
Jx().$package(function(J){
 var url = "http://web.qq.com/?qq=4765078&style=blue";
 // queryObj 则得到一个{qq:"4765078", style:"blue"}的对象。
 var queryObj = J.mapQuery(url);
};
参数:
{String} uri
要映射的 uri
返回:
{Object} 按照 uri 映射成的对象
<static> {Object} string.parseURL(str)
功能:
分解 URL 为一个对象，成员为：scheme, user, pass, host, port, path, query, fragment
参数:
{String} str
URL 地址
返回:
{Object} 如果解析失败则返回 null
<static> {String} string.replaceAll(string, reallyDo, replaceWith, ignoreCase)
功能:
全局替换指定的字符串
参数:
string
reallyDo
replaceWith
ignoreCase
返回:
{String} 返回替换后的字符串
<static> {String} string.rgbToHex(string, array)
功能:
将颜色 RGB 写法转换成 Hex 写法
参数:
string
array
返回:
{String} 返回转换后的字符串
<static> {String} string.stripScripts(string, option)
功能:
脱去script标签
参数:
string
option
返回:
{String} 返回转换后的字符串
<static> {String} string.substitute(string, object, regexp)
功能:
。。。。
参数:
string
object
regexp
返回:
{String} 返回转换后的字符串
<static> {Boolean} string.test(regex, params, params)
功能:
test的方法
参数:
{String|RegExp} regex
正则表达式，或者正则表达式的字符串
{String} params
正则的参数
params
返回:
{Boolean} 返回结果
<static> {Number} string.toFloat(string)
功能:
将字符串转换成浮点数
参数:
{Sring} string
要转换的字符串
返回:
{Number} 返回转换后的浮点数
<static> {Sring} string.toHtml(str)
功能:
将字符串转换成html源码
参数:
{Sring} str
要转换的字符串
返回:
{Sring} 返回转换后的html代码字符串
<static> {Number} string.toInt(string, base)
功能:
将字符串转换成整数
参数:
string
base
返回:
{Number} 返回转换后的整数
<static> {String} string.toQueryPair(obj, value)
功能:
。。。。
参数:
{Object} obj
要转换成查询字符串的对象
value
返回:
{String} 返回转换后的查询字符串
<static> {String} string.toQueryString(obj)
功能:
。。。。
参数:
{Object} obj
要转换成查询字符串的对象
返回:
{String} 返回转换后的查询字符串
<static> {Sring} string.toSingleLine(str)
功能:
将带换行符的字符串转换成无换行符的字符串
参数:
{Sring} str
要转换的字符串
返回:
{Sring} 返回转换后的字符串
<static> {String} string.toString(o)
功能:
将任意变量转换为字符串的方法
参数:
{Mixed} o
任意变量
返回:
{String} 返回转换后的字符串
<static> {Number} string.toTitle(str)
功能:
将字符串转换成用于title的字符串
参数:
{Sring} str
要转换的字符串
返回:
{Number} 返回转换后的in title字符串
<static> {String} string.trim(string)
功能:
清除字符串开头和结尾的空格
参数:
string
返回:
{String} 返回清除后的字符串
<static> {String} string.vaildTencentUrl(sUrl)
功能:
url转向验证 描述：对通过javascript语句载入（或转向）的页面进行验证，防止转到第三方网页和跨站脚本攻击 返回值：true -- 合法；false -- 非法 例： 合法的值 http://xxx.qq.com/hi/redirect.html?url=http://www.qq.com http://xxx.qq.com/hi/redirect.html?url=a.html http://xxx.qq.com/hi/redirect.html?url=/a/1.html 非法的值 http://xxx.qq.com/hi/redirect.html?url=http://www.baidu.com http://xxx.qq.com/hi/redirect.html?url=javascript:codehere http://xxx.qq.com/hi/redirect.html?url=//www.qq.com
参数:
{String} sUrl
返回:
{String}
<static> {String} string.vaildUrl(sUrl)
功能:
验证给定字符串是否是url, 如果是url 则返回正常的url
参数:
{String} sUrl
返回:
{String}
©1998-2012
文档生成 by JsDoc Toolkit 2.4.0 on Fri Jun 21 2013 14:53:56 GMT+0800 (CST)