プライマリ・コンテンツに移動

Oracle® Application Express APIリファレンス リリース5.1 E85937-02 |
| 目次 | 索引

前 | 次 |

# 31.6 apex.langネームスペース

このネームスペースは、Oracle Application Expressのローカライズ関連のファンクションに使用します。

- apex.lang.addMessages
- apex.lang.clearMessages
- apex.lang.format
- apex.lang.formatMessage
- apex.lang.formatMessageNoEscape
- apex.lang.formatNoEscape
- apex.lang.getMessage

## 31.6.1 apex.lang.addMessages

`getMessage`およびformatファンクションで使用するメッセージを追加します。複数回コールできます。追加メッセージがマージされます。「JavaScriptで使用」が「はい」に設定されているアプリケーション・テキスト・メッセージ全部を使用して自動的にコールされるため、通常、このファンクションをコールする必要はありません。

パラメータ

表31-21 apex.lang.addMessagesのパラメータ

名前 | タイプ | 説明
--- | --- | ---
`pMessages` | Object | プロパティがメッセージ・キーのオブジェクトで、値はローカライズされたメッセージ・テキストです。

例

この例では、メッセージを追加します。

    apex.lang.addMessages({
      APPLY_BUTTON_LABEL: "Apply"
    });

## 31.6.2 apex.lang.clearMessages

すべてのメッセージを削除します。

パラメータ

なし

例

この例では、すべてのメッセージを削除します。

    apex.lang.clearMessages()

## 31.6.3 apex.lang.format

formatMessageと同じですが、メッセージ・パターンが直接指定される(すでにローカライズされている、またはローカライズされることになっていない)ことを除きます。キーではありません。置換引数はHTMLエスケープされます。

パラメータ

表31-22 apex.lang.formatのパラメータ

名前 | タイプ | 説明
--- | --- | ---
`pPattern` | String | 1つ以上のパラメータ(%0から%9)を含むメッセージ・パターン。
`...*` | 任意 | メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。文字列でない引数は文字列に変換されます。

戻り値

ローカライズされた書式設定済のメッセージ・テキスト文字列。

例

この例では、`orderTotal`変数が34.00であるとすれば、Total cost: $34.00を戻します。

    apex.lang.format("Total cost: $%0", orderTotal);

参照:

apex.lang.formatMessage

## 31.6.4 apex.lang.formatMessage

メッセージの書式を設定します。メッセージのパラメータ(%0から%9)は対応するファンクションの引数で置換されます。単一の%を含めるには、%%を使用します。置換引数はHTMLエスケープされます。

パラメータ

表31-23 apex.lang.formatMessageのパラメータ

名前 | タイプ | 説明
--- | --- | ---
`pKey` | String | キーは、getMessageと同様に、ローカライズされたメッセージ・テキストの参照に使用されます。
`...*` | 任意 | メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。文字列でない引数は文字列に変換されます。

戻り値

ローカライズされた書式設定済のメッセージ・テキスト文字列。キーが見つからない場合、そのキーが戻されます。

例

この例では、`PROCESS_STATUS`メッセージ・テキストが"Process %0%% complete"であり、progress変数の値が60である場合、"Process 60% complete"を戻します。

    apex.lang.formatMessage("PROCESS_STATUS", progress);

## 31.6.5 apex.lang.formatMessageNoEscape

`formatMessage`と同じですが、置換引数がHTMLエスケープされないことを除きます。安全であると認識される必要があるか、安全なコンテキストで使用される必要があります。apex.lang.formatMessageを参照してください。

パラメータ

表31-24 apex.lang.formatMessageNoEscapeのパラメータ

名前 | タイプ | 説明
--- | --- | ---
`pKey` | String | キーは、getMessageと同様に、ローカライズされたメッセージ・テキストの参照に使用されます。
`...*` | 任意 | メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。

戻り値

ローカライズされた書式設定済のメッセージ・テキスト文字列。キーが見つからない場合、そのキーが戻されます。

例

この例では、CONFIRMメッセージ・テキストが"You entered %0"であり、inputValue変数の値が"<ok>"の場合、"You entered <ok>"を戻します。この文字列は、XSS脆弱性を回避するためにHTMLエスケープが実行されるコンテキストで使用する必要があります。

    apex.lang.formatMessageNoEscape("CONFIRM", inputValue);

## 31.6.6 apex.lang.formatNoEscape

formatと同じですが、置換引数がHTMLエスケープされないことを除きます。安全であると認識される必要があるか、安全なコンテキストで使用される必要があります。

パラメータ

表31-25 apex.lang.formatNoEscapeのパラメータ

名前 | タイプ | 説明
--- | --- | ---
`pPattern` | String | 1つ以上のパラメータ(%0から%9)を含むメッセージ・パターン。
`...*` | 任意 | メッセージ・パラメータ(%0から%9)ごとに1つのオプションの置換値。

戻り値

ローカライズされた書式設定済のメッセージ・テキスト文字列。キーが見つからない場合、そのキーが戻されます。

例

この例では、inputValue変数の値が"<ok>"の場合、"You entered <ok>"を戻します。この文字列は、XSS脆弱性を回避するためにHTMLエスケープが実行されるコンテキストで使用する必要があります。

    apex.lang.formatNoEscape("You entered %0", inputValue);

参照:

「apex.lang.format」

## 31.6.7 apex.lang.getMessage

指定されたキーに関連付けられたメッセージを戻します。キーは、addMessagesで追加されたメッセージで検索されます。

パラメータ

表31-26 apex.lang.getMessageのパラメータ

名前 | タイプ | 説明
--- | --- | ---
`pKey` | String | メッセージ・キー。

戻り値

ローカライズされたメッセージ・テキスト文字列。キーが見つからない場合、そのキーが戻されます。

例

この例では、キー`OK_BTN_LABEL`のローカライズされたテキストが`"OK"`の場合、`"OK"`を戻します。

    apex.lang.getMessage("OK_BTN_LABEL");