Module java.desktop
Package java.awt.im.spi

Interface InputMethodDescriptor


public interface InputMethodDescriptor
定义提供有关输入法的足够信息的方法,以便在实际使用时能够选择和加载该输入法。只有在实际使用时才会加载输入法本身。
自 JDK 版本:
1.3
  • Method Details

    • 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 Exception
      创建相应输入法的新实例。
      返回:
      相应输入法的新实例
      抛出:
      Exception - 创建输入法实例时可能发生的任何异常