Mis favoritos | Español | Acceder

Referencia de clase para el API de transliteración

Índice

Clase google.elements.transliteration.TransliterationControl

Constructor

Las instancias de "google.elements.transliteration.TransliterationControl" están diseñadas para permitir la transliteración en un conjunto de campos de texto de una página web.

Constructor Descripción

TransliterationControl(options)

Crea una nueva instancia de TransliterationControl. El argumento "options" indica las opciones que controlan la transliteración. El argumento "options" puede incluir los siguientes campos:

  • sourceLanguage: campo de cadena obligatorio que especifica el idioma de origen. El valor debe ser del tipo google.elements.transliteration.LanguageCode.
  • destinationLanguage: campo de conjunto obligatorio que especifica el idioma de destino. Los valores del conjunto deben ser del tipo google.elements.transliteration.LanguageCode. El primer idioma del conjunto se seleccionará de forma predeterminada en el menú. Consulta getDestinationLanguages para obtener información más detallada sobre los idiomas de destino válidos para un idioma de origen determinado.
  • transliterationEnabled: campo booleano opcional que especifica si la transliteración se debe habilitar o no de forma predeterminada en los campos de texto. El valor de este campo será "true" si se debe habilitar la transliteración de forma predeterminada o "false" en caso contrario. El valor predeterminado de este campo es "false".
  • shortcutKey: campo de cadena opcional. Especifica la tecla de acceso directo que permite alternar los idiomas de la transliteración. La tecla de acceso directo se especifica como una cadena que contiene modificadores como "ctrl", "alt" o "mayús", junto con una clave alfabética. Por ejemplo, "ctrl+g" y "ctrl+mayús+a" sería una combinación de teclas de acceso directo válida. No se admite el uso de "mayús" como único modificador. Por tanto, "mayús+g" no sería una combinación de teclas de acceso directo válida.

Genera una excepción en los casos siguientes: el valor de "sourceLanguage" o "destinationLanguage" no es válido, no se admite la combinación de idioma de origen e idioma de destino de los campos "sourceLanguage" y "destinationLanguage" de cada uno de los idiomas especificados en el conjunto "destinationLanguage", la combinación de teclas de acceso directo no es válida o se ha intentado crear una segunda instancia de "TransliterationControl" en la misma página.

Métodos

Método Tipo de devolución Descripción

makeTransliteratable(textareaIds, opt_options)

Ninguno

Convierte los campos de texto en campos transliterables y permite la transliteración de cualquier texto introducido en ellos.

  • textareaIds: conjunto que contiene cadenas de identificadores de elementos de campos de texto o referencias a elementos de campos de texto que se deben convertir en transliterables.
  • opt_options: el argumento "opt_options" opcional indica las opciones que se han aplicado para este conjunto de campos de texto. El argumento "opt_options" puede contener los siguientes campos:
    • adjustTextareaStyle: campo booleano opcional. Si el valor de este campo es "true", la fuente y el tamaño del área de texto se ajustarán de forma óptima para adaptarse a los caracteres árabes. El valor predeterminado de este campo es "true".
    • adjustTextareaDirection: campo booleano opcional. Si el valor de este campo es "true", la dirección del área de texto se ajustará de forma óptima de acuerdo con el valor de "destinationLanguage" y los contenidos del área de texto. El valor predeterminado de este campo es "true".

Genera excepciones si el valor de "textareaIds" no es válido.

showControl(divElement)

Ninguno

Muestra el control en el elemento divElement.

  • divElement: ID de cadena del elemento "div" donde se incluirá el control de transliteración.

Métodos avanzados

Método Tipo de devolución Descripción

enableTransliteration()

Ninguno

Activa la transliteración.

disableTransliteration()

Ninguno

Desactiva la transliteración.

toggleTransliteration()

Ninguno

Alterna entre el estado de activación y desactivación de la transliteración.

setLanguagePair(sourceLanguage, destinationLanguage)

Boolean

Cambia la combinación de idiomas de la transliteración.

  • sourceLanguage: el valor debe ser del tipo google.elements.transliteration.LanguageCode.
  • destinationLanguage: el valor debe ser del tipo google.elements.transliteration.LanguageCode.

Devuelve un valor booleano que indica si la acción "setLanguage" se ha realizado correctamente.

Genera una excepción en los siguientes casos: el valor de "sourceLanguage" o "destinationLanguage" no es válido o no se admite la combinación de idioma de origen e idioma de destino de los campos "sourceLanguage" y "destinationLanguage".

getLanguagePair()

Objeto que contiene los campos "sourceLanguage" y "destinationLanguage"

Obtiene la combinación de idiomas actual de la transliteración. Devuelve un objeto que contiene los campos "sourceLanguage" y "destinationLanguage".

isTransliterationEnabled()

Boolean

Devuelve un valor booleano que indica si la transliteración está o no habilitada.

addEventListener(eventType, listener, opt_listenerScope)

Ninguno

Añade una función de escucha para el tipo de evento especificado. Cuando se activa ese tipo de evento específico, se ejecuta la función de escucha con el objeto de evento. El contenido del objeto de evento depende del tipo de evento. Para obtener una descripción más detallada de los distintos tipos de eventos, consulta esta página.

  • eventType: el valor debe ser del tipo google.elements.transliteration.TransliterationControl.EventType..
  • listener: función de escucha del evento.
  • opt_listenerScope: la función de escucha se ejecuta con el objeto "opt_listenerScope" establecido como "this".

removeEventListener(eventType, listener, opt_listenerScope)

Ninguno

Elimina una función de escucha.

  • eventType: el valor debe ser del tipo google.elements.transliteration.TransliterationControl.EventType..
  • listener: función de escucha del evento que se debe eliminar.
  • opt_listenerScope: el ámbito (opt_listenerScope) en el que la función de escucha se registró en el momento de su adición.

Métodos globales

Método Tipo de devolución Descripción
google.elements.transliteration.isBrowserCompatible
Boolean
Devuelve un valor booleano que indica si la transliteración se admite en el navegador del equipo cliente.
google.elements.transliteration.getDestinationLanguages(sourceLanguage)
Asignación de idiomas de destino admitidos con nombre de idioma como clave y código de idioma como valor
Este método devuelve una asignación de idiomas de destino en los que se admite la transliteración para el idioma de origen del campo "sourceLanguage". La asignación obtenida es similar a la que se describe en la sección LanguageCode.
  • sourceLanguage: el valor debe ser del tipo google.elements.transliteration.LanguageCode.

Métodos del API de transliteración de nivel básico

"google.language.transliterate" es un API de nivel básico que se puede ejecutar después de cargar el API AJAX de idiomas tal como se explica en la Guía del desarrollador.

Método Tipo de devolución Descripción
google.language.transliterate(wordsArray, srcLang, destLang, callback)
Ninguno
Es un método global que permite obtener transliteraciones de las palabras especificadas en el idioma de destino. El resultado se proporciona de forma asíncrona a la función callback especificada como el objeto de resultado.
  • wordsArray: las palabras que se deben transliterar especificadas con un formato de conjunto.
  • srcLang: el idioma de origen especificado como un código de idioma. Para ver algunos ejemplos, consulta la sección Enumeración de idiomas.
  • destLang: el idioma de destino especificado como un código de idioma. Para ver algunos ejemplos, consulta la sección Enumeración de idiomas.
  • callback: la función "callback" que recibe el resultado.

Objetos de resultado

Resultado de transliteración

Este objeto de resultado se obtiene cuando se ejecuta "google.language.transliterate()".

  • <resultado>
    • error?
      Aparece si se ha producido algún error en la transliteración.
    • transliterations
      Un conjunto de tamaños igual al tamaño de wordsArray.
      • transliteratedWords
        Un conjunto con un tamaño máximo de cinco, con transliteraciones para la palabra correspondiente en wordsArray.

Enumeraciones

Enumeración EventType

La enumeración "google.elements.transliteration.TransliterationControl.EventType" proporciona posibles eventos que se pueden producir durante la transliteración. Los desarrolladores pueden especificar controladores personalizados para estos eventos.

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 que se activa cuando se habilita o inhabilita la transliteración en "TransliterationControl" de cualquiera de las siguientes formas:
    • mediante la tecla de acceso directo correspondiente,
    • mediante "enableTransliteration", "disableTransliteration" y "toggleTransliteration",
    • haciendo clic en el control de transliteración especificado mediante "showControl".
    El objeto de evento transmitido a la función de escucha contiene el campo "transliterationEnabled", cuyo valor será "true" si la transliteración está activada o "false" si está desactivada.
  • google.elements.transliteration.TransliterationControl.EventType.LANGUAGE_CHANGED: evento que se activa cuando se modifica la combinación de idiomas de "TransliterationControl" de cualquiera de las siguientes formas:
    • mediante "setLanguagePair",
    • mediante "showControl".
    El objeto de evento transmitido a la función de escucha contiene los campos "sourceLanguage" y "destinationLanguage".
  • google.elements.transliteration.TransliterationControl.EventType.SERVER_REACHABLE: evento que se activa cuando se ha podido establecer contacto correctamente con el servidor para la realización de la transliteración.
  • google.elements.transliteration.TransliterationControl.EventType.SERVER_UNREACHABLE: evento que se activa cuando no se ha podido establecer contacto correctamente con el servidor para la realización de la transliteración.

Enumeración LanguageCode

La enumeración "google.elements.transliteration.LanguageCode" proporciona una asignación de constantes de nombres a códigos de idioma que se pueden utilizar para especificar los idiomas de origen y destino en los métodos de transliteración.

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',
};

Enumeración SupportedDestinationLanguages¡Nuevo!

La enumeración "google.elements.transliteration.SupportedDestinationLanguages" proporciona una asignación de constantes de nombres a conjuntos de códigos de idioma que se pueden utilizar para especificar grupos de idiomas de destino de "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]
};