Por favor, lembre-se que esta tradução da especificação é resultado de um projeto da comunidade java.net( https://jdk5-api-pt-br.dev.java.net/). A versão oficial da especificação é a versão na língua inglesa que pode ser encontrada em http://java.sun.com/j2se/1.5.0/docs/api/. Em caso de divergências, a versão predominante da especificação é a original em inglês.

Please note that this translation of the specification is the result of a java.net community project ( https://jdk5-api-pt-br.dev.java.net/ ). The official version of the specification is the US English language version which can be found at http://java.sun.com/j2se/1.5.0/docs/api/. In case of disputes, the authoritative version of the specification is the original, English document.

java.awt.im.spi
Interface InputMethodDescriptor

public interface InputMethodDescriptor

Define métodos que provêm informação suficiente sobre um método de entrada para habilitar a seleção e o carregamento do mesmo. O método de entrada, propriamente dito, só é carregado quando realmente é usado.

Since:

1.3

Method Summary

InputMethod	createInputMethod() Cria uma nova instância do método de entrada correspondente.
Locale[]	getAvailableLocales() Retorna as localidades suportadas pelo método de entrada correspondente.
String	getInputMethodDisplayName(Locale inputLocale, Locale displayLanguage) Retorna o nome visível ao usuário do método de entrada correspondente para uma determinada localidade de entrada na linguagem em que o nome será exibido.
Image	getInputMethodIcon(Locale inputLocale) Retorna um ícone para o método de entrada correspondente.
boolean	hasDynamicLocaleList() Retorna se a lista de localidades disponíveis pode ser alterada em tempo de execução.

Method Detail

getAvailableLocales

Locale[] getAvailableLocales()
                             throws AWTException

Retorna as localidades suportadas pelo método de entrada correspondente. A localidade deve descrever apenas a linguagem, ou pode também incluir informação sobre país e variação, se preciso. A informação é usada para selecionar métodos de entrada por localização (InputContext.selectInputMethod(Locale)). Ela também pode ser usada para encontrar métodos de entrada por localidade em uma lista de métodos de entrada visível ao usuário.

Apenas as localidades primárias do método de entrada devem ser retornadas. Por exemplo, se um método de entrada japonês também possui um modo adaptado para caracteres romanos, tipicamente apenas a localidade japonesa deve ser retornada. Enfim, a lista de localidades retornadas é tipicamente um subconjunto de localidades para as quais a implementação do método de entrada correspondente de InputMethod.setLocale(java.util.Locale) retorna verdadeiro.

Se hasDynamicLocaleList() retorna verdadeiro, este método é chamado toda vez que a informação é necessária. Isso dá aos métodos de entrada que dependem de recursos de rede, a chance de adicionar ou remover localidades de acordo com a disponibilidade dos recursos.

Returns:

as localidades suportadas pelo método de entrada

Throws:

AWTException - se puder ser determinado que o método de entrada é inoperável, por exemplo, por causa de uma instalação incompleta.

hasDynamicLocaleList

boolean hasDynamicLocaleList()

Retorna se a lista de localidades disponíveis pode ser alterada em tempo de execução. Isso pode ser o caso, por exemplo, para adaptadores que acessam métodos de entrada reais através de uma rede.

getInputMethodDisplayName

String getInputMethodDisplayName(Locale inputLocale,
                                 Locale displayLanguage)

Retorna o nome visível ao usuário do método de entrada correspondente para uma determinada localidade de entrada na linguagem em que o nome será exibido.

O parâmetro inputLocale especifica a localidade para qual o texto é inserido. Esse parâmetro pode assumir apenas valores obtidos através do método getAvailableLocales() deste descritor ou null. Se é null, um nome independente de localidade de entrada para o método de entrada deve ser retornado.

Se um nome para a linguagem de exibição desejada não estiver disponível, o método deve recorrer a outra linguagem.

Parameters:

inputLocale - a localidade na qual o texto de entrada é suportado, ou null

displayLanguage - a linguagem em que o nome será exibido

getInputMethodIcon

Image getInputMethodIcon(Locale inputLocale)

Retorna um ícone para o método de entrada correspondente. O ícone pode ser usado pela interface de usuário para a seleção de métodos de entrada.

O parâmetro inputLocale especifica a localidade na qual o texto é inserido. Esse parâmetro pode assumir apenas valores obtidos através do método getAvailableLocales() deste descritor ou null. Se é null, um ícone independente de localidade de entrada para o método de entrada deve ser retornado.

O tamanho do ícone deve ser de 16×16 pixels.

Parameters:

inputLocale - a localidade na qual o texto de entrada é suportado, ou null

Returns:

um ícone para o método de entrada correspondente, ou null

createInputMethod

InputMethod createInputMethod()
                              throws Exception

Cria uma nova instância do método de entrada correspondente.

Returns:

uma nova instância do método de entrada correspondente

Throws:

Exception - qualquer exceção que possa ocorrer durante a criação da instância do método de entrada