JavaTM Platform
Standard Ed. 6

javax.swing.text
接口 Caret

所有已知实现类:
BasicTextUI.BasicCaret, DefaultCaret

public interface Caret

文档视图中的一个位置,它表示文档模型中能插入其他内容的位置。插入符在文档中有一个称作点的位置。点就是插入符当前在模型中的位置。插入符还保留一个位置,它表示选定项的另一端,称为标记。如果没有选定项,点和标记将相等。如果存在选定项,这两个值将不相同。

通过调用 setDotmoveDot 可以放置点。设置点能够移除任何以前存在的选定项。点和标记将相等。移动点将能够创建选定项,而标记将保留在它以前所在的任何位置。


方法摘要
 void addChangeListener(ChangeListener l)
          添加作为跟踪任何插入符位置更改的侦听器。
 void deinstall(JTextComponent c)
          在将 UI 从 JTextComponent 的接口中移除时调用。
 int getBlinkRate()
          获取插入符的闪烁率。
 int getDot()
          获取插入符的当前位置。
 Point getMagicCaretPosition()
          获取当前插入符可见位置。
 int getMark()
          获取标记的当前位置。
 void install(JTextComponent c)
          在将 UI 安装到 JTextComponent 的接口中时调用。
 boolean isSelectionVisible()
          确定选定项当前是否可见。
 boolean isVisible()
          确定插入符当前是否可见。
 void moveDot(int dot)
          将插入符位置(点)移动到其他某个位置,放在标记后面。
 void paint(Graphics g)
          呈现插入符。
 void removeChangeListener(ChangeListener l)
          移除跟踪插入符位置更改的侦听器。
 void setBlinkRate(int rate)
          设置插入符的闪烁率。
 void setDot(int dot)
          将插入符位置设置为其他某个位置。
 void setMagicCaretPosition(Point p)
          设置当前插入符的可视位置。
 void setSelectionVisible(boolean v)
          设置选定项的可见性
 void setVisible(boolean v)
          设置插入符的可见性。
 

方法详细信息

install

void install(JTextComponent c)
在将 UI 安装到 JTextComponent 的接口中时调用。使用它可以获得对正由此接口的实现导航的模型的访问。

参数:
c - JTextComponent

deinstall

void deinstall(JTextComponent c)
在将 UI 从 JTextComponent 的接口中移除时调用。这可用于取消对任何所关联侦听器的注册。

参数:
c - JTextComponent

paint

void paint(Graphics g)
呈现插入符。UI 类调用此方法。

参数:
g - 图形上下文

addChangeListener

void addChangeListener(ChangeListener l)
添加作为跟踪任何插入符位置更改的侦听器。

参数:
l - 更改侦听器

removeChangeListener

void removeChangeListener(ChangeListener l)
移除跟踪插入符位置更改的侦听器。

参数:
l - 更改侦听器

isVisible

boolean isVisible()
确定插入符当前是否可见。

返回:
如果插入符可见,则返回 true;否则返回 false

setVisible

void setVisible(boolean v)
设置插入符的可见性。

参数:
v - 如果插入符应该显示,则返回 true;如果插入符应该隐藏,则返回 false

isSelectionVisible

boolean isSelectionVisible()
确定选定项当前是否可见。

返回:
如果插入符可见,则返回 true;否则返回 false

setSelectionVisible

void setSelectionVisible(boolean v)
设置选定项的可见性

参数:
v - 如果插入符应该显示,则返回 true;如果插入符应该隐藏,则返回 false

setMagicCaretPosition

void setMagicCaretPosition(Point p)
设置当前插入符的可视位置。这可供在具有不规则结束位置的行间(例如,插入符出现上下移动)移动时使用。如果文本按从左到右或从右到左流入,x 坐标将指示垂直移动所需要的导航位置。如果文本按从上到下或从下到上流入,y 坐标将指示水平移动所需要的导航位置。

参数:
p - 用于所保存位置的 Point。它可以为 null,表示无可见位置。

getMagicCaretPosition

Point getMagicCaretPosition()
获取当前插入符可见位置。

返回:
可见位置。
另请参见:
setMagicCaretPosition(java.awt.Point)

setBlinkRate

void setBlinkRate(int rate)
设置插入符的闪烁率。它确定了插入符是否闪烁以及闪烁的速度,通常作为增强插入符的吸引力的一种手段使用。

参数:
rate - 延迟的毫秒数,该值 >= 0。如果该值为零,则插入符不闪烁。

getBlinkRate

int getBlinkRate()
获取插入符的闪烁率。它确定了插入符是否闪烁以及闪烁的速度,通常作为增强插入符的吸引力的一种手段使用。

返回:
延迟的毫秒数,该值 >= 0。 如果该值为零,则插入符不闪烁。

getDot

int getDot()
获取插入符的当前位置。

返回:
位置,其值 >= 0

getMark

int getMark()
获取标记的当前位置。如果有一个选定项,则标记将与点不同。

返回:
位置,其值 >= 0

setDot

void setDot(int dot)
将插入符位置设置为其他某个位置。这使得标记变得与点相同,从而有效地将选定项范围设置为零。

如果参数为负或超出文档的长度,则分别将插入符置于开始位置或结束位置。

参数:
dot - 插入符将设置的新位置

moveDot

void moveDot(int dot)
将插入符位置(点)移动到其他某个位置,放在标记后面。这对进行选择很有用。

参数:
dot - 插入符将移动的新位置,其值 >= 0

JavaTM Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策