JavaTM Platform
Standard Ed. 6

javax.swing.text
接口 Highlighter

所有已知实现类:
BasicTextUI.BasicHighlighter, DefaultHighlighter, LayeredHighlighter

public interface Highlighter

一个允许用户用带有颜色的区域标出背景的对象接口。


嵌套类摘要
static interface Highlighter.Highlight
           
static interface Highlighter.HighlightPainter
          呈现高亮显示。
 
方法摘要
 Object addHighlight(int p0, int p1, Highlighter.HighlightPainter p)
          向视图添加高亮显示。
 void changeHighlight(Object tag, int p0, int p1)
          更改给定的高亮显示,以使其横跨文档的不同部分。
 void deinstall(JTextComponent c)
          将 UI 从 JTextComponent 的接口移除时调用。
 Highlighter.Highlight[] getHighlights()
          获取高亮显示的当前列表。
 void install(JTextComponent c)
          将 UI 安装到 JTextComponent 的接口时调用。
 void paint(Graphics g)
          呈现高亮显示。
 void removeAllHighlights()
          移除此轮廓色负责的所有高亮显示。
 void removeHighlight(Object tag)
          从视图中移除高亮显示。
 

方法详细信息

install

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

参数:
c - JTextComponent 编辑器

deinstall

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

参数:
c - JTextComponent 编辑器

paint

void paint(Graphics g)
呈现高亮显示。

参数:
g - 图形上下文。

addHighlight

Object addHighlight(int p0,
                    int p1,
                    Highlighter.HighlightPainter p)
                    throws BadLocationException
向视图添加高亮显示。返回一个可用于引用高亮显示的标记。

参数:
p0 - 范围的开头,该值 >= 0
p1 - 范围的结尾,该值 >= p0
p - 用于实际高亮显示的 painter
返回:
引用高亮显示的对象
抛出:
BadLocationException - 表明为无效的范围规范

removeHighlight

void removeHighlight(Object tag)
从视图中移除高亮显示。

参数:
tag - 要移除高亮显示

removeAllHighlights

void removeAllHighlights()
移除此轮廓色负责的所有高亮显示。


changeHighlight

void changeHighlight(Object tag,
                     int p0,
                     int p1)
                     throws BadLocationException
更改给定的高亮显示,以使其横跨文档的不同部分。这要比只改变要更改内容来扩大/缩小(如用鼠标扫过)选中项时的移除/添加更有效。

参数:
tag - 要更改的高亮显示
p0 - 范围的开头,该值 >= 0
p1 - 范围的结尾,该值 >= p0
抛出:
BadLocationException - 表明为无效的范围规范

getHighlights

Highlighter.Highlight[] getHighlights()
获取高亮显示的当前列表。

返回:
高亮显示列表

JavaTM Platform
Standard Ed. 6

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

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