gadgets.util
メソッド
gadgets.util.escapeString
<static> String escapeString(str)
HTML エンティティでエスケープします。影響を受ける文字は以下のとおりです。
- 改行 (\n、Unicode 10)
- 復帰 (\r、Unicode 13)
- 二重引用符 ("、Unicode 34)
- アンパサンド (&、Unicode 38)
- 引用符 ('、Unicode 39)
- 小なり記号 (<、Unicode 60)
- 大なり記号 (>、Unicode 62)
- バックスラッシュ (\、Unicode 92)
- 行区切り (Unicode 8232)
- 段落切り (Unicode 8233)
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| str | String | エスケープする文字列。 |
返り値
| 型 | 説明 |
|---|---|
| String | エスケープした文字列。 |
サンプル
var html = gadgets.util.escapeString("<foo>");
// str = <foo>
gadgets.util.getFeatureParameters
<static> Object getFeatureParameters(feature)
この機能のパラメータの値を返します。ガジェットは、
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| feature | String | パラメータを取得する機能。 |
返り値
| 型 | 説明 |
|---|---|
| Object | 指定された機能のパラメータ。無い場合は null。 |
gadgets.util.hasFeature
<static> Boolean hasFeature(feature)
指定された機能がサポートされているかどうかを返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| feature | String | 調べる機能。 |
返り値
| 型 | 説明 |
|---|---|
| Boolean | 機能がサポートされている場合には true |
gadgets.util.registerOnLoadHandler
<static> registarOnLoadHandler(callback)
onload ハンドラを登録します。このハンドラは、ガジェットの読み込み時に実行される関数です。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| callback | Function | 実行するハンドラ。 |
返り値
なし
サンプル
gadgets.util.registerOnLoadHandler(init);
function init() {
//...
}
gadgets.util.unescapeString
<static> String unescapeString(str)
HTML エスケープされた文字を元に戻します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| str | String | エスケープを戻す文字列。 |
返り値
| 型 | 説明 |
|---|---|
| String | エスケープを戻した文字列 |
サンプル
var str = gadgets.util.unescapeString("<foo>");
// str = <foo>
gadgets.util.sanitizeHtml
<static> String sanitizeHtml(htmlText, opt_uriPolicy, opt_nmTokenPolicy)
指定された文字列をサニタイズします。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| htmlText | String | サニタイズされる文字列。 |
| opt_uriPolicy | Function | URLをサニタイズする際の処理。 |
| opt_nmTokenPolicy | Function | idやclassなどをサニタイズする際の処理。。 |
サンプル
var html = gadgets.util.sanitizeHtml('<script type="text/javascript">alert("evil code")</script>');
// html = ""
更新履歴
- 2013/03/15
- ドキュメント移行