Module  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 - 支持文本输入的语言环境，或为空
        displayLanguage - 显示名称的语言
        结果
        给定输入语言环境的相应输入法的用户可见名称，以该名称显示的语言

      • getInputMethodIcon

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

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

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

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

      • createInputMethod

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