- 浏览: 216312 次
- 性别:
- 来自: 北京
文章分类
最新评论
-
dysking:
SWT 和 JFace -
wangyuhfut:
东西不少啊。学习中。。。
一个比较好、中文说明的emacs配置文件 1 -
pacocai:
呵呵!学习,学习~~~不过要说编辑器的话个人更喜欢用VIM,比 ...
一个比较好、中文说明的emacs配置文件 1 -
zhf1zhf2:
这两百多个记起来也不容易啊
英国人是这样背的! -
regex:
试了两次,都是乱码,版本是23.1.1,看来不适合
汉化 Emacs 菜单
https://www.ibm.com/developerworks/cn/opensource/os-cn-ecljtf6/
文档选项
将打印机的版面设置成横向打印模式
打印本页
将此页作为电子邮件发送
将此页作为电子邮件发送
样例代码
级别: 中级
马 若劼 (maruojie@cn.ibm.com), 软件工程师, IBM 中国软件开发中心
2008 年 4 月 10 日
Text Hover(文本悬浮)和 Annotation Hover(标注悬浮)是两种提供快速帮助的功能。本文介绍两种悬浮的基本概念和在 JTF 中的实现方式。
Text Hover
Text Hover(文本悬浮)可以让用户快速的得到某种信息,而不用打开相对缓慢的 Eclipse 帮助系统。Eclipse 的 Java 编辑器使用了文本悬浮来显示 Javadoc 帮助,极大的方便了程序员。从功能上看,文本悬浮可以认为是一种增强型的 Tooltip,因为它支持显示更多的内容,并且可以显示成各种样子。
文本悬浮看起来很酷,但是原理却很简单。基本上就是三个步骤:
1. 根据鼠标位置得到字符偏移
2. 根据字符偏移得到字符所在单词和上下文信息
3. 根据这个单词以及上下文信息显示相关帮助
最关键的事情在于得到字符所在的单词并得到上下文信息,这样才能决定该显示什么样的帮助信息。所以这就又回到了词法解析器和语法解析器的领域了,只好略过不提。不过经过了这么多次的强调之后,希望你对词法解析器和语法解析器的重要性有了深切的体会。它们是代码编辑器里最重要的基石。
第一步不用我们操心,StyledText 已经提供了这样的能力。我们要处理的是第二和第三步。对于文本悬浮,相关的接口是 ITextHover;对于标注悬浮,相关的接口是 IAnnotationHover。
回页首
ITextHover
接下来我打算实现用文本悬浮显示变量值的功能,比如对下面的代码:
清单1. 示例语言
pa = 4;
b = 4;
a = b + 4;
如果你把鼠标移到 a 上,则会显示“8”,如果移到b上,则会显示“4”,是不是很酷呢?
修改解析器
这样的功能没有解析器的支持可不好做,所以我又修改了 Expr.g 文件,使解析器能够保存所有已经声明的变量和它们的值。SharedParser 也做了一定的修改,提供了一个 getVariableValue 方法来根据变量名得到值。用 ANTLR 完成这些事情确实很简单,我就不一一列出代码了。
实现 ITextHover
好消息是 JTF 已经提供了一个缺省的实现,叫做 DefaultTextHover,只要继承一下就可以了。下面是具体的代码:
清单2. ExprTextHover 继承 DefaultTextHover
public class ExprTextHover extends DefaultTextHover {
public ExprTextHover(ISourceViewer sourceViewer) {
super(sourceViewer);
}
@Override
public IRegion getHoverRegion(ITextViewer textViewer, int offset) {
return new Region(offset, 1);
}
@Override
public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
// query super first
String info = super.getHoverInfo(textViewer, hoverRegion);
// if null, use our logic
if(info == null) {
// get document
IDocument doc = textViewer.getDocument();
// get token list
TokenList list = TokenManager.getTokenList(doc);
// get token
Token token = list.getToken(hoverRegion.getOffset());
if(token == null)
return null;
// if token is variable, get variable value
if(token.getType() == IExprTokens.ID) {
// parse
TreeManager.getTree(doc);
return String.valueOf(SharedParser.getVariableValue(token.getText()));
} else
return null;
} else
return info;
}
}
主要的工作在 getHoverInfo 这个方法里面,我先调用了父类的 getHoverInfo,这一般来说是推荐的,因为父类的 getHoverInfo 会去首先查询相应位置处有没有一个标注,如果有,它会返回标注的信息。所以我在后面检查了父类的返回值,如果不是 null 且鼠标下面是一个变量名的话,就从解析器得到变量的值。
配置
最后一步是修改 ExprConfiguration,覆盖 getTextHover 方法, 只是简单的返回我定义的 ExprTextHover 即可。
清单3. 让 JTF 知道我们的 Text Hover 实现
public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
return new ExprTextHover(sourceViewer);
}
效果
运行后,看看是不是得到了我想要的效果:
图1. 文本悬浮效果图
文本悬浮效果图
如我希望的那样,鼠标移动到 a 上面时,显示出了“8”。如果源代码中有错误,那么效果如下所示:
图2. 当源代码有错误时
当源代码有错误时
这正是由于我首先调用了父类的 getHoverInfo 的效果,父类为我们取出了标注信息。
回页首
IAnnotationHover
Annotation Hover(标注悬浮)只能给标尺上的标注提供悬浮帮助。在实现上,它比文本悬浮更简单一些,因为你不需要判断鼠标所在单词,也不需要想办法获取一些上下文信息。JTF 也提供了缺省实现:DefaultAnnotationHover。我在例子中继承了它,但是什么都没有覆盖。然后在 ExprConfiguration 中覆盖 getAnnotationHover 即可,和文本悬浮非常类似。
下面是标注悬浮的效果:
图3. 标注悬浮效果图
标注悬浮效果图
显示的信息和图2是一样的,因为是同一个标注。如果想返回不同的信息,覆盖 DefaultAnnotationHover 的 getHoverInfo 方法就可以了。
回页首
关于信息显示控件
我曾经在本系列的第四部分提过:JTF使用了一些接口来抽象信息显示方面的功能,比如 IInformationControl 代表了一个信息显示控件,IInformationControlCreator 代表了一个信息显示控件工厂。既然文本悬浮和标注悬浮也是显示信息,那么它们可以不可以定制信息显示控件呢?
答案是绝对没问题,但是你在 ITextHover 和 IAnnotationHover 找不到与之有关系的方法。是不是想起了什么?那些带有“Extension”字样的接口?Bingo! 看看 ITextHoverExtension 和 IAnnotationHoverExtension 吧,具体怎么做我就不演示了。
回页首
Accessibility
一个要达到产品级的软件,必须要考虑 Accessibility 的问题,所谓 Accessibility,简单的说,就是让残疾人也能够使用你的软件。Accessibility 有一个很基本的要求就是关键的文字都要能被读屏软件读出来。文本悬浮和标注悬浮是很酷,但是它带来了 Accessibility 方面的问题,因为悬浮窗口没有焦点,读屏软件是不会读它们的。我们看看在 Java 编辑器中,它如何解决这个问题:
图4. Java 编辑器中的文本悬浮
Java 编辑器中的文本悬浮
可以看到 Java 编辑器的文本悬浮窗口下面有一个提示:按 F2 之后可以得到焦点。这个功能即方便了查看一些比较长的帮助,又解决了 Accessibility 的问题。
我这里不演示具体步骤,但是给有兴趣的读者一些提示:
1. 悬浮窗口下面的提示可以通过 DefaultInformationControl 的构造函数传进去,如果你用的其它的信息控件,则看具体情况。
2. 为了处理相应的快捷键,需要定义一个快捷键绑定,快捷键发生的时候调用相应的方法把信息控件变成可设置焦点的。Eclipse中有一些代码可以参考,比如 InformationDispatchAction,它是 TextEditorAction 的内部类。
回页首
AbstractInfor...
如果你是一个喜欢刨根问底的人,你可能会问:我虽然实现了 TextHover 接口,但是文本编辑器是怎么知道什么时候该调用我这个接口的呢?文本编辑器不是上帝,它当然是不知道的,需要外力帮助它知道。可以看看 AbstractInformationControlManager 这个类以及它的子类,会发现它有一个叫做 TextViewerHoverManager 的子类,是不是有点明白了呢?原来 TextViewerHoverManager 会安装在 TextViewer 上,它会监听悬浮事件,然后负责调用我们的实现。
从 AbstractInformationControlManager 可以看出一点:JFace 把信息显示功能包装成了通用的模块,并不是一定要在文本编辑器这样的场合才可以用悬浮信息窗口。如果你需要在其它地方添加类似的功能,可以继承 AbstractInformationControlManager,完成你自己的信息显示功能。
回页首
结束语
又给大家留下了可以发挥的地方,我小小的总结一下:
1. 没有提供自定义的信息显示控件
2. 没有实现悬浮窗口的可焦点化
3. 尝试为其它东西实现一个悬浮提示功能,比如工具条?
如果上面这些部分你都能完成的话,相信你就可以做出来非常专业的悬浮帮助系统了。
回页首
声明
本文仅代表作者的个人观点,不代表 IBM 的立场。
文档选项
将打印机的版面设置成横向打印模式
打印本页
将此页作为电子邮件发送
将此页作为电子邮件发送
样例代码
级别: 中级
马 若劼 (maruojie@cn.ibm.com), 软件工程师, IBM 中国软件开发中心
2008 年 4 月 10 日
Text Hover(文本悬浮)和 Annotation Hover(标注悬浮)是两种提供快速帮助的功能。本文介绍两种悬浮的基本概念和在 JTF 中的实现方式。
Text Hover
Text Hover(文本悬浮)可以让用户快速的得到某种信息,而不用打开相对缓慢的 Eclipse 帮助系统。Eclipse 的 Java 编辑器使用了文本悬浮来显示 Javadoc 帮助,极大的方便了程序员。从功能上看,文本悬浮可以认为是一种增强型的 Tooltip,因为它支持显示更多的内容,并且可以显示成各种样子。
文本悬浮看起来很酷,但是原理却很简单。基本上就是三个步骤:
1. 根据鼠标位置得到字符偏移
2. 根据字符偏移得到字符所在单词和上下文信息
3. 根据这个单词以及上下文信息显示相关帮助
最关键的事情在于得到字符所在的单词并得到上下文信息,这样才能决定该显示什么样的帮助信息。所以这就又回到了词法解析器和语法解析器的领域了,只好略过不提。不过经过了这么多次的强调之后,希望你对词法解析器和语法解析器的重要性有了深切的体会。它们是代码编辑器里最重要的基石。
第一步不用我们操心,StyledText 已经提供了这样的能力。我们要处理的是第二和第三步。对于文本悬浮,相关的接口是 ITextHover;对于标注悬浮,相关的接口是 IAnnotationHover。
回页首
ITextHover
接下来我打算实现用文本悬浮显示变量值的功能,比如对下面的代码:
清单1. 示例语言
pa = 4;
b = 4;
a = b + 4;
如果你把鼠标移到 a 上,则会显示“8”,如果移到b上,则会显示“4”,是不是很酷呢?
修改解析器
这样的功能没有解析器的支持可不好做,所以我又修改了 Expr.g 文件,使解析器能够保存所有已经声明的变量和它们的值。SharedParser 也做了一定的修改,提供了一个 getVariableValue 方法来根据变量名得到值。用 ANTLR 完成这些事情确实很简单,我就不一一列出代码了。
实现 ITextHover
好消息是 JTF 已经提供了一个缺省的实现,叫做 DefaultTextHover,只要继承一下就可以了。下面是具体的代码:
清单2. ExprTextHover 继承 DefaultTextHover
public class ExprTextHover extends DefaultTextHover {
public ExprTextHover(ISourceViewer sourceViewer) {
super(sourceViewer);
}
@Override
public IRegion getHoverRegion(ITextViewer textViewer, int offset) {
return new Region(offset, 1);
}
@Override
public String getHoverInfo(ITextViewer textViewer, IRegion hoverRegion) {
// query super first
String info = super.getHoverInfo(textViewer, hoverRegion);
// if null, use our logic
if(info == null) {
// get document
IDocument doc = textViewer.getDocument();
// get token list
TokenList list = TokenManager.getTokenList(doc);
// get token
Token token = list.getToken(hoverRegion.getOffset());
if(token == null)
return null;
// if token is variable, get variable value
if(token.getType() == IExprTokens.ID) {
// parse
TreeManager.getTree(doc);
return String.valueOf(SharedParser.getVariableValue(token.getText()));
} else
return null;
} else
return info;
}
}
主要的工作在 getHoverInfo 这个方法里面,我先调用了父类的 getHoverInfo,这一般来说是推荐的,因为父类的 getHoverInfo 会去首先查询相应位置处有没有一个标注,如果有,它会返回标注的信息。所以我在后面检查了父类的返回值,如果不是 null 且鼠标下面是一个变量名的话,就从解析器得到变量的值。
配置
最后一步是修改 ExprConfiguration,覆盖 getTextHover 方法, 只是简单的返回我定义的 ExprTextHover 即可。
清单3. 让 JTF 知道我们的 Text Hover 实现
public ITextHover getTextHover(ISourceViewer sourceViewer, String contentType) {
return new ExprTextHover(sourceViewer);
}
效果
运行后,看看是不是得到了我想要的效果:
图1. 文本悬浮效果图
文本悬浮效果图
如我希望的那样,鼠标移动到 a 上面时,显示出了“8”。如果源代码中有错误,那么效果如下所示:
图2. 当源代码有错误时
当源代码有错误时
这正是由于我首先调用了父类的 getHoverInfo 的效果,父类为我们取出了标注信息。
回页首
IAnnotationHover
Annotation Hover(标注悬浮)只能给标尺上的标注提供悬浮帮助。在实现上,它比文本悬浮更简单一些,因为你不需要判断鼠标所在单词,也不需要想办法获取一些上下文信息。JTF 也提供了缺省实现:DefaultAnnotationHover。我在例子中继承了它,但是什么都没有覆盖。然后在 ExprConfiguration 中覆盖 getAnnotationHover 即可,和文本悬浮非常类似。
下面是标注悬浮的效果:
图3. 标注悬浮效果图
标注悬浮效果图
显示的信息和图2是一样的,因为是同一个标注。如果想返回不同的信息,覆盖 DefaultAnnotationHover 的 getHoverInfo 方法就可以了。
回页首
关于信息显示控件
我曾经在本系列的第四部分提过:JTF使用了一些接口来抽象信息显示方面的功能,比如 IInformationControl 代表了一个信息显示控件,IInformationControlCreator 代表了一个信息显示控件工厂。既然文本悬浮和标注悬浮也是显示信息,那么它们可以不可以定制信息显示控件呢?
答案是绝对没问题,但是你在 ITextHover 和 IAnnotationHover 找不到与之有关系的方法。是不是想起了什么?那些带有“Extension”字样的接口?Bingo! 看看 ITextHoverExtension 和 IAnnotationHoverExtension 吧,具体怎么做我就不演示了。
回页首
Accessibility
一个要达到产品级的软件,必须要考虑 Accessibility 的问题,所谓 Accessibility,简单的说,就是让残疾人也能够使用你的软件。Accessibility 有一个很基本的要求就是关键的文字都要能被读屏软件读出来。文本悬浮和标注悬浮是很酷,但是它带来了 Accessibility 方面的问题,因为悬浮窗口没有焦点,读屏软件是不会读它们的。我们看看在 Java 编辑器中,它如何解决这个问题:
图4. Java 编辑器中的文本悬浮
Java 编辑器中的文本悬浮
可以看到 Java 编辑器的文本悬浮窗口下面有一个提示:按 F2 之后可以得到焦点。这个功能即方便了查看一些比较长的帮助,又解决了 Accessibility 的问题。
我这里不演示具体步骤,但是给有兴趣的读者一些提示:
1. 悬浮窗口下面的提示可以通过 DefaultInformationControl 的构造函数传进去,如果你用的其它的信息控件,则看具体情况。
2. 为了处理相应的快捷键,需要定义一个快捷键绑定,快捷键发生的时候调用相应的方法把信息控件变成可设置焦点的。Eclipse中有一些代码可以参考,比如 InformationDispatchAction,它是 TextEditorAction 的内部类。
回页首
AbstractInfor...
如果你是一个喜欢刨根问底的人,你可能会问:我虽然实现了 TextHover 接口,但是文本编辑器是怎么知道什么时候该调用我这个接口的呢?文本编辑器不是上帝,它当然是不知道的,需要外力帮助它知道。可以看看 AbstractInformationControlManager 这个类以及它的子类,会发现它有一个叫做 TextViewerHoverManager 的子类,是不是有点明白了呢?原来 TextViewerHoverManager 会安装在 TextViewer 上,它会监听悬浮事件,然后负责调用我们的实现。
从 AbstractInformationControlManager 可以看出一点:JFace 把信息显示功能包装成了通用的模块,并不是一定要在文本编辑器这样的场合才可以用悬浮信息窗口。如果你需要在其它地方添加类似的功能,可以继承 AbstractInformationControlManager,完成你自己的信息显示功能。
回页首
结束语
又给大家留下了可以发挥的地方,我小小的总结一下:
1. 没有提供自定义的信息显示控件
2. 没有实现悬浮窗口的可焦点化
3. 尝试为其它东西实现一个悬浮提示功能,比如工具条?
如果上面这些部分你都能完成的话,相信你就可以做出来非常专业的悬浮帮助系统了。
回页首
声明
本文仅代表作者的个人观点,不代表 IBM 的立场。
发表评论
-
基于 JFace Text Framework 构建全功能代码编辑器: 第 7 部分:
2009-05-17 16:18 1055https://www.ibm.com/developerwo ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 5 部分:
2009-05-14 17:32 1165https://www.ibm.com/developerwo ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 4 部分
2009-05-14 17:31 1505Content Assistant developerWor ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 3 部分
2009-05-14 17:30 1264Double Click 和 Triple Click de ... -
实战SWT布局
2008-12-08 00:55 1395标准的SWT布局类 FillLayou ... -
SWT布局
2008-12-08 00:53 1123另外参见:http://java.chinaitlab.com ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 2 部分
2008-11-19 18:12 1188Syntax Highlight developerWork ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 1 部分
2008-11-19 18:11 1192级别: 中级 马 若劼 (maruojie@cn.ibm.c ... -
SWT 和 JFace, 第 2 部分: 简介
2008-11-19 18:06 1125http://www.ibm.com/developerwor ... -
SWT 和 JFace,第 1 部分: 简介
2008-11-19 18:04 1168http://www.ibm.com/developerwor ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 8 部分:
2008-11-19 03:54 0https://www.ibm.com/developerwo ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 10 部分:Text F
2008-11-19 03:50 0https://www.ibm.com/developerwo ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 11 部分:
2008-11-19 03:48 0https://www.ibm.com/developerwo ... -
基于 JFace Text Framework 构建全功能代码编辑器: 第 9 部分:Templa
2008-11-19 03:23 0基于 JFace Text Framework 构 ... -
JFace Text Editor完全掌握之终极指南
2008-06-13 01:57 1889JFace Text Editor是JFace里面一个功能强大 ... -
JFace 视图
2008-06-13 01:49 1132http://blog.itpub.net/post/5050 ... -
SWT的体系结构
2008-06-13 01:18 1222http://flyingbug.blogdriver.com ... -
SWT 全接触
2008-06-13 01:15 1708http://blog.csdn.net/DL88250/ar ... -
细说:AWT,SWT,Swing
2008-06-13 00:42 1963http://www.java3z.com/cwbwebhom ... -
SWT的--键盘事件处理
2008-06-12 21:51 2305http://203.208.37.104/search?q= ...
相关推荐
基于_JFace_Text_Framework_构建全功能代码编辑器
IBM官方网站的JFace Text Framework教程,教大家如何实现代码提示,字体着色,语法分析等方法。是一个非常好的教程。
org.eclipse.jface.text_3.14.0.v20180824-1140,最新版Eclipse代码上屏jar包,修改了代码上屏按键,取消空格上屏,不会使用的小伙伴请百度Eclipse代码上屏优化!
因为10.7.1已经完美破解(修正了war文件到处问题),故放上该版本修改过的org.eclipse.jface.text_3.7.2.v20111213-1208.jar 代码补全空格不上屏,适合习惯使用vs等工具的用户 详细描述参见10.0时的插件 ...
将现有JAR文件直接替换对应的org.eclipse.jface.text_*(后面的是版本号),只能提示增强,能在abcdef....等输入时提示,解决空格和=不能输入的问题(第一次自己编译的插件 嘎嘎)只能提示增强方法自己搜,这个是解决...
解决代码自动补全时按空格键也上屏问题
myeclipse的自动补全代码有时会显得多余,给属性添加类型名,用这个替换掉\eclipse\plugins目录下的插件可以取消“空格”和“等号”下的自动补全功能,适用版本:org.eclipse.jface.text_3.8.2.v20121126-164145。...
将此jar包替换掉eclipse中plugins目录下的同名jar包即可解决代码自动补全时按空格键也上屏问题
使用代码提示时按下空格键(;=)不会自动上屏,而是使用Tab键来上屏。
eclipse_4.7.3a,eclipse/plugins里面的org.eclipse.jface.text,按“=”和空格以后不会自动补完代码,防止eclipse过于的智能
已经去了空格代码提示,适用于eclipse neon版本,以及基于neon的IDE
最新版Eclipse代码自动补全,替换Eclipse安装目录下制定jar包,实现只有tab下智能提示代码上屏,回车空格状态下正常!
org.eclipse.jface.text_3.14.0.v20180824-1140.jar,取消优化代码智能提示后Eclipse空格键代码上屏的困扰,配置代码智能提示,替换plugin文件夹下同名jar包,即可,不会用的小伙伴可以百度一下Eclipse代码自动上屏!
这个是针对Eclipse SDK Version: 3.7 jface.text._3.7.2源码。可直接修改该版本的内容。实现自己想要的功能。
将压缩包放在eclipse根目录下 解压缩全替换 注意备份 org.eclipse.jface.text_3.12
jface.text3.9的源代码, eclipse自动补全插件相关 来自 : http://vdisk.weibo.com/s/aWiTqHd1bs37I
这个是针对Eclipse SDK Version: 4.3. jface.text._3.8.1源码。可直接修改该版本的内容。实现自己想要的功能。
jface.text - Jar [去掉 空格 + 等号的提示] by 970655147
eclipse 取消 "=",空格,“.”的自动补全。org.eclipse.jface.text_3.9.2.v20141003-1326.jar修改版。 使用方法:解压复制到安装目录的同级目录替换即可。安全起见,可以先备份原文件。