API AJAX de idioma do Google

API AJAX de idioma do Google
- Guia do desenvolvedor
- Playground de código
- Referência de Classe

Referência de classe para a API de transliteração

Sumário

Classe google.elements.transliteration.TransliterationControl: Construtor; Métodos; Métodos avançados

Métodos globais: google.elements.transliteration.isBrowserCompatible; google.elements.transliteration.getDestinationLanguages

Métodos da API de transliteração de nível inferior: google.language.transliterate

Objetos de resultado: Resultado da transliteração

Enumerações: EventType; LanguageCode; SupportedDestinationLanguages^Novo!

Classe google.elements.transliteration.TransliterationControl

Construtor

As instâncias do google.elements.transliteration.TransliterationControl são desenvolvidas para permitir a transliteração em um conjunto de campos de texto na sua página web.

Construtor Descrição

Construtor	Descrição
`TransliterationControl(options)`	Cria uma nova instância de `TransliterationControl` O argumento options fornece as opções que controlam a transliteração. O argumento options pode conter os seguintes campos: sourceLanguage - Campos obrigatório da string que especifica o idioma de origem. O valor deve ser do tipo `google.elements.transliteration.LanguageCode` destinationLanguage - Campo obrigatório da matriz que especifica o idioma de destino. Os valores na matriz devem ser do tipo `google.elements.transliteration.LanguageCode`. O primeiro idioma na matriz será selecionado por padrão no menu. Consulte getDestinationLanguages para obter mais detalhes com relação aos idiomas de destino válidos para um determinado idioma de origem. TransliterationEnabled - Campo booleano opcional que especifica se a transliteração deve ou não ser ativada por padrão nos campos de texto. True, se a transliteração deve ser ativada por padrão. Caso contrário, false. O valor padrão para este campo é false. shortcutKey - Campo da string opcional. Especifica a tecla de atalho usada para ativar ou desativar a transliteração. A tecla de atalho é especificada como uma string contendo modificadores como "ctrl", "alt" ou "shift" juntamente com uma tecla do alfabeto. Por exemplo, "ctrl+g", "ctrl+shift+a" seriam combinações válidas para a tecla de atalho. Não permitimos "shift" como único modificador. Por isso, "shift+g" não seria uma combinação válida para a tecla de atalho. Causa exceções nos seguintes casos: sourceLanguage ou destinationLanguage é inválido, o par de idiomas sourceLanguage-destinationLanguage não é suportado para cada um dos idiomas especificados na matriz destinationLanguage, a combinação da tecla de atalho é inválida ou foi feita uma tentativa de criar uma segunda instância de TransliterationControl na mesma página.

TransliterationControl(options)

Cria uma nova instância de TransliterationControl O argumento options fornece as opções que controlam a transliteração. O argumento options pode conter os seguintes campos:

sourceLanguage - Campos obrigatório da string que especifica o idioma de origem. O valor deve ser do tipo google.elements.transliteration.LanguageCode
destinationLanguage - Campo obrigatório da matriz que especifica o idioma de destino. Os valores na matriz devem ser do tipo google.elements.transliteration.LanguageCode. O primeiro idioma na matriz será selecionado por padrão no menu. Consulte getDestinationLanguages para obter mais detalhes com relação aos idiomas de destino válidos para um determinado idioma de origem.
TransliterationEnabled - Campo booleano opcional que especifica se a transliteração deve ou não ser ativada por padrão nos campos de texto. True, se a transliteração deve ser ativada por padrão. Caso contrário, false. O valor padrão para este campo é false.
shortcutKey - Campo da string opcional. Especifica a tecla de atalho usada para ativar ou desativar a transliteração. A tecla de atalho é especificada como uma string contendo modificadores como "ctrl", "alt" ou "shift" juntamente com uma tecla do alfabeto. Por exemplo, "ctrl+g", "ctrl+shift+a" seriam combinações válidas para a tecla de atalho. Não permitimos "shift" como único modificador. Por isso, "shift+g" não seria uma combinação válida para a tecla de atalho.

Causa exceções nos seguintes casos: sourceLanguage ou destinationLanguage é inválido, o par de idiomas sourceLanguage-destinationLanguage não é suportado para cada um dos idiomas especificados na matriz destinationLanguage, a combinação da tecla de atalho é inválida ou foi feita uma tentativa de criar uma segunda instância de TransliterationControl na mesma página.

Métodos

Método Tipo de retorno Descrição

Método	Tipo de retorno	Descrição
`makeTransliteratable(textareaIds, opt_options)`	Nenhum	Torna os campos de texto transliteráveis e permite a transliteração de qualquer texto digitado. textareaIds - Matriz contendo strings de IDs do elemento campo de texto ou referências do elemento campo de texto que devem se tornar transliteráveis. opt_options - O argumento opt_options opcional fornece as opções aplicadas para este conjunto de campos de texto. O argumento opt_options pode conter os seguintes campos: adjustTextareaStyle - Campo booleano opcional. Se for true, o tamanho e a fonte da área do texto serão ajustados da melhor forma para acomodar caracteres índicos e árabes. O valor padrão para este campo é true. adjustTextareaDirection - Campo booleano opcional. Se for true, a direção da área de texto é ajustada da melhor forma de acordo com a direção de destinationLanguage e com o conteúdo da área de texto. O valor padrão para este campos é true. Causa exceções no seguinte caso: IDs da área de texto inválidos
`showControl(divElement)`	Nenhum	Mostra o controle no `divElement`. divElement - ID da string do div no qual o controle de transliteração será desenhado.

makeTransliteratable(textareaIds, opt_options)

Nenhum

Torna os campos de texto transliteráveis e permite a transliteração de qualquer texto digitado.

textareaIds - Matriz contendo strings de IDs do elemento campo de texto ou referências do elemento campo de texto que devem se tornar transliteráveis.
opt_options - O argumento opt_options opcional fornece as opções aplicadas para este conjunto de campos de texto. O argumento opt_options pode conter os seguintes campos:
- adjustTextareaStyle - Campo booleano opcional. Se for true, o tamanho e a fonte da área do texto serão ajustados da melhor forma para acomodar caracteres índicos e árabes. O valor padrão para este campo é true.
- adjustTextareaDirection - Campo booleano opcional. Se for true, a direção da área de texto é ajustada da melhor forma de acordo com a direção de destinationLanguage e com o conteúdo da área de texto. O valor padrão para este campos é true.

Causa exceções no seguinte caso: IDs da área de texto inválidos

showControl(divElement)

Nenhum

Mostra o controle no divElement.

divElement - ID da string do div no qual o controle de transliteração será desenhado.

Métodos avançados

Método	Tipo de retorno	Descrição
`enableTransliteration()`	Nenhum	Ativa a transliteração.
`disableTransliteration()`	Nenhum	Desativa a transliteração.
`toggleTransliteration()`	Nenhum	Alterna os status da transliteração entre ativado e desativado.
`setLanguagePair(sourceLanguage, destinationLanguage)`	Booleano	Altera o par de idioma para transliteração. sourceLanguage - O valor deve ser do tipo `google.elements.transliteration.LanguageCode` destinationLanguage - O valor deve ser do tipo `google.elements.transliteration.LanguageCode` Retorna um valor booleano indicando se a ação de setLanguage foi bem-sucedida. Causa uma exceção nos seguintes casos: sourceLanguage ou destinationLanguage é inválido, o par de idiomas sourceLanguage-destinationLanguage não é suportado
`getLanguagePair()`	Objeto com campos sourceLanguage e destinationLanguage	Obtém o par de idiomas atual para transliteração. Retorna um objeto que contém os campos sourceLanguage e destinationLanguage.
`isTransliterationEnabled()`	Booleano	Retorna um valor booleano indicando se a transliteração está ativada ou não.
`addEventListener(eventType, listener, opt_listenerScope)`	Nenhum	Adiciona uma escuta para o tipo de evento fornecido. Quando um tipo de evento específico é disparado, a escuta é chamada com o objeto do evento. O conteúdo do objeto do evento depende do tipo de evento. Os EventTypes são descritos com mais detalhes aqui. eventType - O valor deve ser um dos `google.elements.transliteration.TransliterationControl.EventType.` listener - Função de escuta para o evento. opt_listenerScope - A escuta será chamada com "este" conjunto para o objeto opt_listenerScope.
`removeEventListener(eventType, listener, opt_listenerScope)`	Nenhum	Remove uma escuta. eventType - O valor deve ser um dos `google.elements.transliteration.TransliterationControl.EventType.` listener - Função de escuta para o evento que precisa ser removido. opt_listenerScope - O escopo (opt_listenerScope) no qual a escuta foi registrada no momento da sua adição.

Métodos globais

Método	Tipo de retorno	Descrição
`google.elements.transliteration.isBrowserCompatible`	Booleano	Retorna um valor booleano indicando se a transliteração é suportada no navegador do cliente.
`google.elements.transliteration.getDestinationLanguages(sourceLanguage)`	Mapa dos idiomas de destino suportados, com a chave como nome do idioma e o valor como código do idioma	Para o sourceLanguage fornecido, retorna um mapa dos idiomas de destino para os quais a transliteração é suportada. O mapa retornado é semelhante ao mapa descrito na seção LanguageCode. sourceLanguage - O valor deve ser do tipo `google.elements.transliteration.LanguageCode`

Métodos da API de transliteração de nível inferior

google.language.transliterate é uma API de nível inferior que pode ser chamada após o carregamento da API AJAX de idioma do Google, conforme explicado no Guia do desenvolvedor

Método	Tipo de retorno	Descrição
`google.language.transliterate(wordsArray, srcLang, destLang, callback)`	Nenhum	Um método global que irá obter as transliterações das palavras fornecidas no idioma de destino. O resultado é fornecido de forma assíncrona à função `callback` especificada, como o objeto de resultado. wordsArray - As palavras que devem ser transliteradas, especificadas em um formato de matriz. srcLang - O idioma de origem como um código de idioma. Consulte Enumeração de idiomas para obter exemplos. destLang - O idioma de destino como um código de idioma. Consulte Enumeração de idiomas para obter exemplos. callback - A função de retorno de chamada que recebe o resultado.

Objetos de resultado

Resultado da transliteração

Este objeto result é obtido quando a chamada google.language.transliterate() é invocada.

<result>
- error?
  
  Presente se houver um erro na transliteração.
  - code
    
    Um código de erro em estilo HTTP.
  - message
    
    Uma descrição da string do erro que pode ser lida.
- transliterations
  
  Uma matriz com tamanho igual ao tamanho da wordsArray de entrada.
  - transliteratedWords
    
    Uma matriz com tamanho máximo de 5, com transliterações para a palavra correspondente em wordsArray.

Enumerações

Enumeração EventType

A enumeração de google.elements.transliteration.TransliterationControl.EventType fornece os possível eventos que podem ser disparados durante a transliteração. Os desenvolvedores pode fornecer manipuladores personalizados para esses eventos em seus códigos.

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: evento disparado quando a transliteração é ativada ou desativada no TransliterationControl de uma das seguintes maneiras:
- Quando a transliteração é ativada ou desativada usando a tecla de atalho.
- Quando a transliteração é ativada ou desativada usando enableTransliteration, disableTransliteration e toggleTransliteration.
- Quando a transliteração é ativada ou desativada clicando no controle de transliteração desenhado pelo showControl.
O objeto event passado para a escuta contém o campo transliterationEnabled, que é true se a transliteração estiver "ativada" ou, caso contrário, false.
google.elements.transliteration.TransliterationControl.EventType.LANGUAGE_CHANGED: Evento disparado quando o par de idiomas da transliteração é alterado no TransliterationControl de uma das seguintes maneiras:
- Quando o par de idiomas da transliteração é alterado usando setLanguagePair.
- Quando o idioma da transliteração é alterado no controle de transliteração desenhado pelo showControl.
O objeto event passado para a escuta contém os campos sourceLanguage e destinationLanguage.
google.elements.transliteration.TransliterationControl.EventType.SERVER_REACHABLE: Evento disparado quando foi possível entrar em contato com servidor para realização da transliteração.
google.elements.transliteration.TransliterationControl.EventType.SERVER_UNREACHABLE: Evento disparado quando não foi possível entrar em contato com servidor para realização da transliteração.

Enumeração LanguageCode

A enumeração google.elements.transliteration.LanguageCode fornece um mapeamento das constantes de nome para códigos de idioma que podem ser usados para especificar os idiomas de origem e de destino nos métodos de transliteração.

var google.elements.transliteration.LanguageCode = {
    ENGLISH: 'en',
    ARABIC: 'ar',
    BENGALI: 'bn',
    GUJARATI: 'gu',
    HINDI: 'hi',
    KANNADA: 'kn',
    MALAYALAM: 'ml',
    MARATHI: 'mr',
    NEPALI: 'ne',
    TAMIL: 'ta',
    TELUGU: 'te',
};

Enumeração SupportedDestinationLanguages ^Novo!

A enumeração google.elements.transliteration.SupportedDestinationLanguages fornece um mapeamento das constantes de nome para as matrizes dos códigos de idioma que podem ser usadas para especificar grupos de idiomas de destino no TransliterationControl.

var google.elements.transliteration.SupportedDestinationLanguages = {
    // ALL includes all languages supported in the transliteration API. 
    // As support for more languages becomes available, this enum will be
    // automatically updated to include the new languages transparently.
    ALL: [
        google.elements.transliteration.LanguageCode.ARABIC,
        google.elements.transliteration.LanguageCode.BENGALI,
        google.elements.transliteration.LanguageCode.GUJARATI,
        google.elements.transliteration.LanguageCode.HINDI,
        google.elements.transliteration.LanguageCode.KANNADA,
        google.elements.transliteration.LanguageCode.MALAYALAM,
        google.elements.transliteration.LanguageCode.MARATHI,
        google.elements.transliteration.LanguageCode.NEPALI,
        google.elements.transliteration.LanguageCode.TAMIL,
        google.elements.transliteration.LanguageCode.TELUGU],

    // INDIC includes all Indic languages supported in the transliteration API. 
    // As support for more Indic languages becomes available, this enum will be
    // automatically updated to include the new languages transparently.
    INDIC: [
        google.elements.transliteration.LanguageCode.BENGALI,
        google.elements.transliteration.LanguageCode.GUJARATI,
        google.elements.transliteration.LanguageCode.HINDI,
        google.elements.transliteration.LanguageCode.KANNADA,
        google.elements.transliteration.LanguageCode.MALAYALAM,
        google.elements.transliteration.LanguageCode.MARATHI,
        google.elements.transliteration.LanguageCode.NEPALI,
        google.elements.transliteration.LanguageCode.TAMIL,
        google.elements.transliteration.LanguageCode.TELUGU]
};


por ex. "apis ajax" ou "software livre"

API AJAX de idioma do Google