java.awt.im

接口
类

java.awt.im
类 InputMethodHighlight

java.lang.Object
  继承者 java.awt.im.InputMethodHighlight

public class InputMethodHighlight
     

      extends 
      Object

InputMethodHighlight 用于描述正在撰写的文本的高亮显示属性。该描述可以有两个级别：抽象级，它可指定转换状态和是否已选定文本；具体级，它可指定用来呈现高亮显示的样式属性。InputMethodHighlight 必须提供抽象级描述；可提供也可以不提供具体级描述。如果不提供具体样式，则呈现程序应使用 Toolkit.mapInputMethodHighlight(java.awt.im.InputMethodHighlight) 来映射一个具体样式。

抽象描述由三个字段组成：selected、state 和 variation。selected 指示文本范围是否是输入方法当前使用的范围，例如，当前在菜单上显示转换备选项的单元。state 表示转换状态。状态值由输入方法框架定义，并且应该在从抽象样式到具体样式的所有映射中明确地表示出来。当前定义的状态值是原值（未转换）和已转换的值。建议在采取撰写文本的主要转换步骤前后使用这些状态值，比方说，在 kana->kanji 或 pinyin->hanzi 转换前后。variation 字段允许输入方法表达有关转换结果的其他信息。

InputMethodHighlight 通常用作从用于 INPUT_METHOD_HIGHLIGHT 属性的 AttributedCharacterIterator 返回的属性值。可以将它们包装到 Annotation 实例中，以指示独立的文本单元。

从以下版本开始：
1.2
另请参见：
AttributedCharacterIterator

字段摘要
static int CONVERTED_TEXT
          已转换文本状态的常量。
static int RAW_TEXT
          原文本状态的常量。
static InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
          已选定已转换文本的默认高亮显示常量。
static InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
          已选定原文本的默认高亮显示常量。
static InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
          未选定已转换文本的默认高亮显示常量。
static InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
          未选定原文本的默认高亮显示常量。
 
构造方法摘要
InputMethodHighlight(boolean selected, int state)
          构造输入方法高亮显示记录。
InputMethodHighlight(boolean selected, int state, int variation)
          构造输入方法高亮显示记录。
InputMethodHighlight(boolean selected, int state, int variation, Map<TextAttribute,?> style)
          构造输入方法高亮显示记录。
 
方法摘要
 int getState()
          返回文本范围的转换状态。
 Map<TextAttribute,?> getStyle()
          返回文本范围的呈现样式属性，或 null。
 int getVariation()
          返回文本范围的变量。
 boolean isSelected()
          返回是否已选定文本范围。
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

字段详细信息

RAW_TEXT

public static final int RAW_TEXT
原文本状态的常量。

另请参见：
常量字段值

CONVERTED_TEXT

public static final int CONVERTED_TEXT
已转换文本状态的常量。

另请参见：
常量字段值

UNSELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_RAW_TEXT_HIGHLIGHT
未选定原文本的默认高亮显示常量。

SELECTED_RAW_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_RAW_TEXT_HIGHLIGHT
已选定原文本的默认高亮显示常量。

UNSELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight UNSELECTED_CONVERTED_TEXT_HIGHLIGHT
未选定已转换文本的默认高亮显示常量。

SELECTED_CONVERTED_TEXT_HIGHLIGHT

public static final InputMethodHighlight SELECTED_CONVERTED_TEXT_HIGHLIGHT
已选定已转换文本的默认高亮显示常量。

构造方法详细信息

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state)
构造输入方法高亮显示记录。变量设置为 0，样式设置为 null。

参数：
selected - 是否已选定文本范围
state - 文本范围的转换状态——RAW_TEXT 或 CONVERTED_TEXT
抛出：
IllegalArgumentException - 如果给定了 RAW_TEXT 或 CONVERTED_TEXT 之外的状态
另请参见：
RAW_TEXT, CONVERTED_TEXT

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state,
                            int variation)
构造输入方法高亮显示记录。样式设置为 null。

参数：
selected - 是否已选定文本范围
state - 文本范围的转换状态——RAW_TEXT 和 CONVERTED_TEXT
variation - 文本范围的样式变量
抛出：
IllegalArgumentException - 如果给定了 RAW_TEXT 或 CONVERTED_TEXT 之外的状态
另请参见：
RAW_TEXT, CONVERTED_TEXT

InputMethodHighlight

public InputMethodHighlight(boolean selected,
                            int state,
                            int variation,
                            Map<TextAttribute,?> style)
构造输入方法高亮显示记录。所提供的样式属性映射必须是不可修改的。

参数：
selected - 是否已选定文本范围
state - 文本范围的转换状态——RAW_TEXT 或 CONVERTED_TEXT
variation - 文本范围的变量
style - 文本范围的呈现样式属性，或 null
抛出：
IllegalArgumentException - 如果给定了 RAW_TEXT 或 CONVERTED_TEXT 之外的状态
从以下版本开始：
1.3
另请参见：
RAW_TEXT, CONVERTED_TEXT
方法详细信息

isSelected

public boolean isSelected()
返回是否已选定文本范围。

getState

public int getState()
返回文本范围的转换状态。

返回：
文本范围的转换状态——RAW_TEXT 或 CONVERTED_TEXT。
另请参见：
RAW_TEXT, CONVERTED_TEXT

getVariation

public int getVariation()
返回文本范围的变量。

getStyle

public Map<TextAttribute,?> getStyle()
返回文本范围的呈现样式属性，或 null。

从以下版本开始：
1.3