java.awt.im

Interface InputMethodRequests

All Known Subinterfaces:

InputMethodContext

public interface InputMethodRequests

inputmethodrequests定义文本编辑组件处理为与输入法工作的要求。组件可以实现这个接口本身或使用一个单独的对象来实现它。实现此接口的对象必须从组件的getinputmethodrequests方法返回。

文本编辑组件还提供了一个输入法事件侦听器。

该接口被设计为支持两个输入用户界面之一：

• 现场输入，其中的组合的文本显示为文本组件的文本正文的一部分。
• 在下面的点输入，其中的组合的文本显示在一个单独的组成窗口，只是低于插入点，其中的文本将被插入时，它是提交。请注意，如果在组件的文本正文中选择文本，该文本将被承诺的承诺文本替换；因此，它不被视为文本输入到的上下文的一部分。

从以下版本开始：

一点二

另请参见：

Component.getInputMethodRequests()， InputMethodListener

方法摘要

Modifier and Type	Method and Description
AttributedCharacterIterator	cancelLatestCommittedText(AttributedCharacterIterator.Attribute[] attributes) 从文本编辑组件中获取最新提交的文本，并将其从组件的文本体中删除。
AttributedCharacterIterator	getCommittedText(int beginIndex, int endIndex, AttributedCharacterIterator.Attribute[] attributes) 获取一个迭代器提供访问整个文本和属性中包含的文本编辑组件除了自由文本。
int	getCommittedTextLength() 获取整个文本的长度包含在文本编辑组件除了中立（组成）的文本。
int	getInsertPositionOffset() 获取文本编辑组件中包含的已提交文本中的插入位置的偏移量。
TextHitInfo	getLocationOffset(int x, int y) 获取在屏幕上指定的绝对X和Y坐标的组合文本中的偏移量。
AttributedCharacterIterator	getSelectedText(AttributedCharacterIterator.Attribute[] attributes) 从文本编辑组件中获取当前选定的文本。
Rectangle	getTextLocation(TextHitInfo offset) 获取当前组合文本中指定偏移量的位置，或提交的文本中的选择位置。

方法详细信息

getTextLocation

Rectangle getTextLocation(TextHitInfo offset)

获取当前组合文本中指定偏移量的位置，或提交的文本中的选择位置。此信息是，例如，用于将候选窗口定位在所组成的文本附近，或在提交文本的位置附近的一个组合窗口。

如果组件组成的文本（因为它包含文本发送到最近的inputmethodevent），然后偏移是相对于由文本偏移0表示第一个字符组成的文本。返回的位置应该是这个字符。

如果组件没有包含文本，偏移量应该被忽略，并且返回的位置应该反映在包含选定文本的最后一行中的亮点的开始（在行方向）中。例如，对于水平左到右文本（如英语），返回的位置在最后一行包含选定的文本的左侧的大多数字符的位置。对于垂直上下文本，从右到左行的行，返回到左行的顶部的位置，包含选定的文本的位置。

的位置被表示为一个0-thickness符号，即，如果文本绘制水平有0宽，0高如果文本绘制垂直。其他文本的方向需要被映射到水平或垂直方向。矩形使用绝对的屏幕坐标。

参数

offset在正文的偏移，如果有空则由文本；

结果

表示偏移位置的屏幕位置的矩形

getLocationOffset

TextHitInfo getLocationOffset(int x,
                              int y)

获取在屏幕上指定的绝对X和Y坐标的组合文本中的偏移量。此信息被使用，例如，处理鼠标点击和鼠标光标。偏移量是相对于所合成的文本，所以偏移量0表示组成文本的开始。

如果位置在由所组成的文本所占据的区域之外，则返回空值。

参数

x -绝对的x坐标在屏幕上

y -绝对的Y坐标在屏幕上

结果

一个描述在合成文本中偏移的文本的文本。

getInsertPositionOffset

int getInsertPositionOffset()

获取文本编辑组件中包含的已提交文本中的插入位置的偏移量。这是通过插入输入法输入的字符的偏移量。此信息被一个输入法使用，例如检查插入位置周围的文本。

结果

插入位置的偏移量

getCommittedText

AttributedCharacterIterator getCommittedText(int beginIndex,
                                             int endIndex,
                                             AttributedCharacterIterator.Attribute[] attributes)

获取一个迭代器提供访问整个文本和属性中包含的文本编辑组件除了自由文本。未提交的（组成）的文本应为指数计算中忽略和不应该通过迭代器访问。

输入方法可以提供一个它感兴趣的属性列表。在这种情况下，信息的其他属性，实现可能不需要通过迭代器访问。如果列表是空的，所有可用的属性信息都应该是可访问的。

参数

beginIndex -第一个字符的索引

endIndex -最后一个字符后的字符的索引

attributes -目录，输入法感兴趣的属性

结果

提供对文本的访问和它的属性的迭代器

getCommittedTextLength

int getCommittedTextLength()

获取整个文本的长度包含在文本编辑组件除了中立（组成）的文本。

结果

长度的文本除了自由文本

cancelLatestCommittedText

AttributedCharacterIterator cancelLatestCommittedText(AttributedCharacterIterator.Attribute[] attributes)

从文本编辑组件中获取最新提交的文本，并将其从组件的文本体中删除。这是用于“撤消承诺“在某些输入法的特点，在将文本恢复到其以前由国家。组成的文本将被发送到使用inputmethodevent组件。

一般情况下，此功能只应在文本提交后立即支持，而不是在用户在文本上执行其他操作之后才予以支持。当不支持该功能时，返回空。

输入方法可以提供一个它感兴趣的属性列表。在这种情况下，信息的其他属性，实现可能不需要通过迭代器访问。如果列表是空的，所有可用的属性信息都应该是可访问的。

参数

attributes -目录，输入法感兴趣的属性

结果

不支持“撤消提交”功能时最新提交的文本或“空”

getSelectedText

AttributedCharacterIterator getSelectedText(AttributedCharacterIterator.Attribute[] attributes)

从文本编辑组件中获取当前选定的文本。这可能是用于各种用途。其中之一是“将”在一些输入法的特征。在这种情况下，输入法通常会发送一个输入法事件来替换所选的文本与组合的文本。根据输入法的功能，这可能是为选定的文本的原始组合文本，最新的组合文本输入在文本的任何地方，或从选定的文本转换回来的文本的版本。

输入方法可以提供一个它感兴趣的属性列表。在这种情况下，信息的其他属性，实现可能不需要通过迭代器访问。如果列表是空的，所有可用的属性信息都应该是可访问的。

参数

attributes -目录，输入法感兴趣的属性

结果

当前选定的文本