Google AJAX Language API

AJAX Language API
- デベロッパーガイド
- Code Playground^New!
- クラスリファレンス
  - Translation API
  - Transliteration API^New!

Transliteration API のクラスリファレンス

Class google.elements.transliteration.TransliterationControl

コンストラクタ

google.elements.transliteration.TransliterationControl のインスタンスは、ウェブページの一連のテキストフィールドで文字変換ができるように設計されています。

コンストラクタ説明

コンストラクタ	説明
`TransliterationControl(options)`	新しい `TransliterationControl` インスタンスを作成します。オプション引数は、文字変換を制御するオプションを指定します。オプション引数には、次のフィールドを含めることができます。 sourceLanguage - 変換元言語を指定する必須の文字列フィールド。値は `google.elements.transliteration.LanguageCode` 型にする必要があります。 destinationLanguage - 変換先言語を指定する必須の文字列フィールド。値は `google.elements.transliteration.LanguageCode` 型にする必要があります。指定された変換元言語に対する有効な変換先言語の詳細については、getDestinationLanguages を参照してください。 isTransliterationEnabled - デフォルトでテキストフィールドの文字変換を有効にするかどうかを指定するブール値フィールド（省略可能）。文字変換をデフォルトで有効にする場合は true、それ以外の場合は false にします。このフィールドのデフォルト値は false です。 shortcutKey - 文字列フィールド（省略可能）。文字変換を切り換えるために使用するショートカットキーを指定します。ショートカットキーは、「Ctrl」、「Alt」、「Shift」などの修飾子とアルファベットキーを含む文字列として指定します。たとえば、「Ctrl+G」、「Ctrl+Shift+A」は、有効なショートカットキーの組み合わせです。「Shift」のみを修飾子として使用することはできません。したがって、「Shift+G」は、有効なショートカットキーの組み合わせではありません。 sourceLanguage または destinationLanguage が無効な場合、sourceLangauge と destinationLanguage の言語ペアがサポートされていない場合、shortcutKey の組み合わせが無効な場合、または同じページで TransliterationControl の 2 番目のインスタンスを作成しようとした場合は、例外がスローされます。

TransliterationControl(options)

新しい TransliterationControl インスタンスを作成します。オプション引数は、文字変換を制御するオプションを指定します。オプション引数には、次のフィールドを含めることができます。

sourceLanguage - 変換元言語を指定する必須の文字列フィールド。値は google.elements.transliteration.LanguageCode 型にする必要があります。
destinationLanguage - 変換先言語を指定する必須の文字列フィールド。値は google.elements.transliteration.LanguageCode 型にする必要があります。指定された変換元言語に対する有効な変換先言語の詳細については、getDestinationLanguages を参照してください。
isTransliterationEnabled - デフォルトでテキストフィールドの文字変換を有効にするかどうかを指定するブール値フィールド（省略可能）。文字変換をデフォルトで有効にする場合は true、それ以外の場合は false にします。このフィールドのデフォルト値は false です。
shortcutKey - 文字列フィールド（省略可能）。文字変換を切り換えるために使用するショートカットキーを指定します。ショートカットキーは、「Ctrl」、「Alt」、「Shift」などの修飾子とアルファベットキーを含む文字列として指定します。たとえば、「Ctrl+G」、「Ctrl+Shift+A」は、有効なショートカットキーの組み合わせです。「Shift」のみを修飾子として使用することはできません。したがって、「Shift+G」は、有効なショートカットキーの組み合わせではありません。

sourceLanguage または destinationLanguage が無効な場合、sourceLangauge と destinationLanguage の言語ペアがサポートされていない場合、shortcutKey の組み合わせが無効な場合、または同じページで TransliterationControl の 2 番目のインスタンスを作成しようとした場合は、例外がスローされます。

メソッド

メソッド戻りタイプ説明

メソッド	戻りタイプ	説明
`makeTransliteratable(textareaIds, opt_options)`	なし	テキストフィールドを文字変換可能にし、これらに入力された任意の内容が文字変換されるようにします。 textareaIds - 文字変換可能にする必要がある一連のテキストフィールド要素の ID またはテキストフィールド要素の参照の文字列を含む配列です。 opt_options - opt_options 引数（省略可能）は、この一連のテキストフィールドに適用するオプションを提供します。opt_options 引数には、次のフィールドを含めることができます。 adjustTextareaStyle - ブール値子フィールド（省略可能）。true の場合、テキストフィールドのサイズとフォントは、インド語文字に合わせて最適に調整されます。このフィールドのデフォルト値は true です。 textareaIds が無効な場合は、例外がスローされます。
`showControl(divElement, opt_options)`	なし	`divElement` にコントロールを表示します。 divElement - 文字変換コントロールを描画する div の文字列 ID。 opt_options - opt_options 引数（省略可能）は、コントロールの表示方法を制御するオプションを提供します。opt_options 引数には、次のフィールドを含めることができます。 controlType - `google.elements.transliteration.TransliterationControl.ControlType` 型のフィールド（省略可能）で、ユーザーが複数の言語を選択できるか、または単一の言語だけを表示するかを指定します。デフォルト値は `google.elements.transliteration.TransliterationControl.ControlType.MULTI_LANGUAGE_BUTTON` です。

makeTransliteratable(textareaIds, opt_options)

なし

テキストフィールドを文字変換可能にし、これらに入力された任意の内容が文字変換されるようにします。

textareaIds - 文字変換可能にする必要がある一連のテキストフィールド要素の ID またはテキストフィールド要素の参照の文字列を含む配列です。
opt_options - opt_options 引数（省略可能）は、この一連のテキストフィールドに適用するオプションを提供します。opt_options 引数には、次のフィールドを含めることができます。
- adjustTextareaStyle - ブール値子フィールド（省略可能）。true の場合、テキストフィールドのサイズとフォントは、インド語文字に合わせて最適に調整されます。このフィールドのデフォルト値は true です。

textareaIds が無効な場合は、例外がスローされます。

showControl(divElement, opt_options)

なし

divElement にコントロールを表示します。

divElement - 文字変換コントロールを描画する div の文字列 ID。
opt_options - opt_options 引数（省略可能）は、コントロールの表示方法を制御するオプションを提供します。opt_options 引数には、次のフィールドを含めることができます。
- controlType - google.elements.transliteration.TransliterationControl.ControlType 型のフィールド（省略可能）で、ユーザーが複数の言語を選択できるか、または単一の言語だけを表示するかを指定します。デフォルト値は google.elements.transliteration.TransliterationControl.ControlType.MULTI_LANGUAGE_BUTTON です。

高度なメソッド

メソッド	戻りタイプ	説明
`enableTransliteration()`	なし	文字変換をオンにします。
`disableTransliteration()`	なし	文字変換をオフにします。
`toggleTransliteration()`	なし	文字変換のオン/オフのステータスを切り換えます。
`setLanguagePair(sourceLanguage, destinationLanguage)`	Boolean	文字変換の言語ペアを変更します。 sourceLanguage - 値は `google.elements.transliteration.LanguageCode` 型にする必要があります。 destinationLanguage - 値は `google.elements.transliteration.LanguageCode` 型にする必要があります。 setLanguage アクションが成功したかどうかを示すブール値を返します。 sourceLanguage または destinationLanguage が無効な場合、または souceLangauge と destinationLanguage の言語ペアがサポートされていない場合は、例外がスローされます。
`getLanguagePair()`	sourceLanguage フィールドと destinationLanguage フィールドを含むオブジェクト	文字変換の現在の言語ペアを取得します。sourceLanguage フィールドと destinationLanguage フィールドを含むオブジェクトを返します。
`isTransliterationEnabled()`	Boolean	文字変換が有効になっているかどうかを示すブール値を返します。
`addEventListener(eventType, listener, opt_listenerScope)`	なし	指定されたイベント型のリスナーを追加します。特定のイベント型が呼び出されると、イベントオブジェクトとともにリスナーが呼び出されます。イベントオブジェクトのコンテンツは、イベントの型に依存し、EventType の詳細についてはここを参照してください。 eventType - 値は `google.elements.transliteration.TransliterationControl.EventType.` のいずれかです。 listener - イベントのリスナー関数です。 opt_listenerScope - リスナーは、「this」を opt_listenerScope オブジェクトに設定して呼び出します。
`removeEventListener(eventType, listener, opt_listenerScope)`	なし	リスナーを削除します。 eventType - 値は `google.elements.transliteration.TransliterationControl.EventType.` のいずれかです。 listener - イベントのリスナー関数です。 opt_listenerScope - リスナーは、「this」を opt_listenerScope オブジェクトに設定して呼び出します。

グローバルメソッド

メソッド	戻りタイプ	説明
`google.elements.transliteration.isBrowserCompatible`	Boolean	文字変換がクライアントのブラウザでサポートされているかどうかを示すブール値を返します。
`google.elements.transliteration.getDestinationLanguages(sourceLanguage)`	言語名のキーと言語コードの値によるサポートされている変換先言語のマップです。	これは、指定された sourceLanguage に対して、文字変換がサポートされている変換先言語のマップを返します。返されたマップは、LanguageCode セクションに表示されているマップとほとんど同じです。 sourceLanguage - 値は `google.elements.transliteration.LanguageCode` 型にする必要があります。
`google.elements.transliteration.isLanguagePairSupported(sourceLanguage, destinationLanguage)`	Boolean	言語ペアが文字変換をサポートする場合は true を返します。 sourceLanguage - 値は `google.elements.transliteration.LanguageCode` 型にする必要があります。 destinationLanguage - 値は `google.elements.transliteration.LanguageCode` 型にする必要があります。

下位 Transliteration API のメソッド

google.language.transliterate は、デベロッパーガイドで説明されているように、AJAX Language API を読み込んでから呼び出すことができる下位 API です。

メソッド	戻りタイプ	説明
`google.language.transliterate(wordsArray, srcLang, destLang, callback)`	なし	指定された語句の文字変換を変換先言語で取得するグローバルメソッドです。結果は、指定された `callback` 関数とは非同期に、結果オブジェクトとして提供されます。 wordsArray - 配列形式でされた文字変換する語句です。 srcLang - 変換元言語の言語コード。例については、Language 列挙を参照してください。 destLang - 変換先言語の言語コード。例については、Language 列挙を参照してください。 callback - 結果を受け取るコールバック関数。

結果オブジェクト

文字変換の結果

この結果オブジェクトは、google.language.transliterate() が呼び出されたときに取得されます。

<result>
- error?
  
  文字変換にエラーがあった場合に存在します。
  - code
    
    HTTP スタイルのエラーコード。
  - message
    
    人間が読めるエラー説明の文字列。
- transliterations
  
  入力 wordsArray に等しいサイズの配列です。
  - transliteratedWords
    
    wordsArray の対応する単語の文字変換を含む最大サイズ 5 の配列です。

列挙

ControlType 列挙

google.elements.transliteration.TransliterationControl.ControlType 列挙は、表示されるコントロールボタンに対して許容できるタイプ値を指定します。これによって、ユーザーは複数の言語を選択するか、または単一の言語だけを表示できます。

var google.elements.transliteration.TransliterationControl.ControlType = {
  SINGLE_LANGUAGE_BUTTON: 'single',
  MULTI_LANGUAGE_BUTTON: 'multi'
};

EventType 列挙

google.elements.transliteration.TransliterationControl.EventType 列挙は、文字変換中に呼び出すことができるイベントを指定します。デベロッパーは、各自のコードでイベントにカスタムハンドラを指定できます。

var google.elements.transliteration.TransliterationControl.EventType = {
   STATE_CHANGED: 'state_changed',
   LANGUAGE_CHANGED: 'language_changed',
   SERVER_REACHABLE:'server_reachable',
   SERVER_UNREACHABLE:'server_unreachable'
};

google.elements.transliteration.TransliterationControl.EventType.STATE_CHANGED: TransliterationControl で次のいずれかの方法で文字変換が有効または無効になると、イベントが呼び出されます。
- ショートカットキーを使用して文字変換が有効または無効になった場合。
- enableTransliteration、disableTransliteration、および toggleTransliteration を使用して文字変換が有効または無効になった場合。
- showControl によって描画された文字変換コントロールをクリックして、文字変換が有効または無効になった場合。
文字変換がオンの場合に true、それ以外の場合は false に設定される transliterationEnabled フィールドを含むリスナーに渡されるイベントオブジェクトです。
google.elements.transliteration.TransliterationControl.EventType.LANGUAGE_CHANGED: TransliterationControl で文字変換の言語ペアが次のいずれかの方法で変更されるとイベントが呼び出されます。
- setLanguagePair を使用して、文字変換の言語ペアが変更された場合。
- showControl によって描画された文字変換コントロールから文字変換が変更された場合。
リスナーに渡されたイベントオブジェクトに、sourceLanguage フィールドと destinationLanguage フィールドが含まれる場合。
google.elements.transliteration.TransliterationControl.EventType.SERVER_REACHABLE: 文字変換するためにサーバーに正常に接続できた場合にイベントが呼び出されます。
google.elements.transliteration.TransliterationControl.EventType.SERVER_UNREACHABLE: 文字変換するためにサーバーに正常に接続できなかった場合にイベントが呼び出されます。

LanguageCode 列挙

google.elements.transliteration.LanguageCode 列挙は、名前定数から言語コードへのマッピングを提供します。このマッピングは、文字変換メソッドで変換元と変換先の言語を指定するために使用できます。

var google.elements.transliteration.LanguageCode = {
    ENGLISH: 'en',
    HINDI: 'hi',
    KANNADA: 'kn',
    MALAYALAM: 'ml',
    TAMIL: 'ta',
    TELUGU: 'te',                
};


例: "ajax apis" または "オープンソース"