模块  java.desktop
软件包  java.awt.im.spi

Interface InputMethodDescriptor

  • public interface InputMethodDescriptor
    定义提供有关输入方法的足够信息的方法，以启用对该输入方法的选择和加载。 输入方法本身仅在实际使用时加载。
    从以下版本开始：
    1.3

    • 方法详细信息

      • getAvailableLocales

        Locale[] getAvailableLocales()
                      throws AWTException
        返回相应输入方法支持的语言环境。 区域设置可以仅描述语言，或者如果需要还可以包括国家和变体信息。 该信息用于按区域设置选择输入方法（ InputContext.selectInputMethod(Locale) ）。 它还可以用于按用户可见的输入方法列表中的区域设置对输入方法进行排序。

        只应返回输入方法的主要语言环境。 例如，如果日语输入法也具有罗马字符的传递模式，则通常仍然只返回日语。 因此，返回的语言环境列表通常是语言环境的一个子集，对应的输入方法的实现InputMethod.setLocale(java.util.Locale)返回true。

        如果hasDynamicLocaleList()返回true，则每次需要信息时都会调用此方法。 这为依赖于网络资源的输入方法提供了在资源可用或不可用时添加或删除语言环境的机会。

        结果
        输入方法支持的语言环境
        异常
        AWTException - 如果可以确定输入方法不可操作，例如，由于安装不完整。

      • hasDynamicLocaleList

        boolean hasDynamicLocaleList()
        返回可用语言环境列表是否可以在运行时更改。 例如，对于通过网络访问实际输入方法的适配器可能就是这种情况。
        结果
        可用语言环境列表是否可以在运行时更改

      • getInputMethodDisplayName

        String getInputMethodDisplayName​(Locale inputLocale,
                                 Locale displayLanguage)
        以将显示名称的语言返回给定输入语言环境的相应输入方法的用户可见名称。

        inputLocale参数指定输入文本的语言环境。 此参数只能获取从此描述符的getAvailableLocales()方法获得的值或null。 如果为null，则应返回输入方法的输入语言环境独立名称。

        如果所需显示语言的名称不可用，则该方法可能会回退到其他语言。

        参数
        inputLocale - 支持文本输入的语言环境，或null
        displayLanguage - 将显示名称的语言
        结果
        用于显示名称的语言中给定输入语言环境的相应输入方法的用户可见名称

      • getInputMethodIcon

        Image getInputMethodIcon​(Locale inputLocale)
        返回相应输入方法的图标。 用户界面可以使用该图标来选择输入方法。

        inputLocale参数指定输入文本的语言环境。 此参数只能获取从此描述符的getAvailableLocales()方法获取的值或null。 如果为null，则应返回输入方法的输入区域设置独立图标。

        图标的大小应为16×16像素。

        参数
        inputLocale - 支持文本输入的语言环境，或null
        结果
        相应输入法的图标，或null

      • createInputMethod

        InputMethod createInputMethod()
                       throws 异常
        创建相应输入方法的新实例。
        结果
        相应输入法的新实例
        异常
        异常 - 创建输入方法实例时可能发生的任何异常