BlogJava-eroself-随笔分类-Eclipse

RCP系统开发

鬼谷子 — Mon, 25 Feb 2008 04:04:00 GMT

摘要: 摘自：http://book.csdn.net/bookfiles/493/10049317083.shtml 从本章开始，将带领大家进入激动人心的Eclipse RCP开发之旅。本章先将经费测算系统的架子搭建起来，例如菜单、工具栏、主控界面等等，至于系统各功能的实现细节，在随后的章节中将层层剥开。为了节省篇幅，从本章开始，对于大量需要导入的类，在程序代码中将予以省略。本章将主要学习到以... 阅读全文

鬼谷子 2008-02-25 12:04 发表评论

扩展Eclipse视图弹出菜单

鬼谷子 — Sat, 23 Feb 2008 02:37:00 GMT

转自：http://cnfree2000.spaces.live.com/blog/cns!6201144F025F9D77!426.entry

Eclipse里每种编辑器都有它自己的视图，有时候我们需要在上面添加自己的功能，扩充视图弹出菜单则是必不可少的工作之一。

在一个视图的Popup Menu里增加一个菜单项，含有2种方式：

1、viewerContribution，也就是通过视图的id。这样只有视图id和给定的id一致的时候，它的弹出菜单才会增加我们定义的菜单项。

2、objectContribution，通过对象类型。当在视图里选定的对象类型和给定的一致时，在视图的弹出菜单增加我们定义的菜单项。

菜单项的Action需要继承org.eclipse.ui.actions.ActionDelegate，然后实现特殊的View的ActionDelegate接口。比如要扩展Java编辑器：

public class FinderActionDelegate extends ActionDelegate implements
        IEditorActionDelegate {

来看看插件的Plugin.xml的组成部分：

viewerContribution形式：
             point="org.eclipse.ui.popupMenus">
                   targetID="#TextEditorContext"
            id="com.cnfree.finder.editor">
                         label="查找最大ID"
               icon="icon/search.gif"
               helpContextId="com.cnfree.finder.finderaction"
               class="com.cnfree.finder.FinderActionDelegate"
               menubarPath="additions"
               enablesFor="+"
               id="com.cnfree.finder">


                   targetID="#CompilationUnitEditorContext"
            id="com.cnfree.finder.editor">
                         label="查找最大ID"
               icon="icon/search.gif"
               helpContextId="com.cnfree.finder.finderaction"
               class="com.cnfree.finder.FinderActionDelegate"
               menubarPath="additions"
               enablesFor="*"
               id="com.cnfree.finder">


    < br />             point="org.eclipse.ui.editorActions">


这里我们需要知道扩展的视图它的菜单项在Eclipse插件注册表里定义的id（稍后我会附上Eclipse插件菜单项ID注册表）。比如Java编辑器对应的ID为：
#TextEditorContext 和 #CompilationUnitEditorContext，我们定义好 targetID，就把我们的插件id指向视图菜单的id了。这样Java编辑器就会添加我们的菜单项了。

   id            CDATA #REQUIRED
   label         CDATA #REQUIRED
   menubarPath   CDATA #IMPLIED
   toolbarPath   CDATA #IMPLIED
   icon          CDATA #IMPLIED
   disabledIcon  CDATA #IMPLIED
   hoverIcon     CDATA #IMPLIED
   tooltip       CDATA #IMPLIED
   helpContextId CDATA #IMPLIED
   style         (push|radio|toggle) "push"
   state         (true | false)
   class         CDATA #REQUIRED
   enablesFor    CDATA #IMPLIED>
< br />此元素定义用户可在用户界面中调用的操作。

id －用作此操作的引用的唯一标识。
label －用作菜单项文本或工具栏按钮标签的可翻译名称。此名称可包括助记符信息。
menubarPath －用来指定下拉菜单中此操作位置的以斜杠（“/”）定界的路径。路径中的每个标记（最后一个标记除外）都必须表示层次结构中现有菜单的有效标识。最后一个标记表示要将操作添加到其中的命名组。如果省略了路径，则此操作将不会出现在下拉菜单中。
toolbarPath －目标视图的本地工具栏内的命名组。如果该组不存在，则将创建它。如果省略该项，则操作将不会出现在本地工具栏中。
icon －用来在操作的上下文中可视地表示操作的图标的相对路径。如果省略该项且操作出现在工具栏中，则“工作台”将使用占位符图标。该路径是相对于添加插件的 plugin.xml 文件的位置的。图标将出现在工具栏中，但是不会出现在下拉菜单中。
disabledIcon －当禁用操作时，用于在操作的上下文中可视地表示操作的图标的相对路径。如果省略该项，则正常图标将变灰。该路径是相对于添加插件的 plugin.xml 文件的位置的。禁用的图标将出现在工具栏中，但是不会出现在下拉菜单中。
hoverIcon －当鼠标指针位于操作上时，用来在操作的上下文中可视地表示操作的图标的相对路径。如果省略此项，则将使用正常图标。该路径是相对于添加插件的 plugin.xml 文件的位置的。
tooltip －表示操作的工具提示的可翻译文本。仅当操作出现在工具栏中时才使用。
helpContextId －一个指示此操作的帮助上下文的唯一标识。如果操作作为菜单项出现，则在突出显示该菜单项时按 F1 键将显示帮助。
style －用来定义操作的用户界面样式类型的可选属性。如果定义了此项，则属性值将是下列其中一项：
   push －作为普通菜单项或工具项。
   radio －作为单选样式菜单项或工具项。同一菜单或工具栏组内具有单选样式的操作相当于单选按钮集。初始值由 state 属性指定。
   toggle －作为复选样式菜单项或切换工具项。初始值由 state 属性指定。
state －指示初始状态（true 或 false）的可选属性，当 style 属性具有值 radio 或 toggle 时使用。
class －实现 org.eclipse.ui.IViewActionDelegate 的标准类的名称。
enablesFor －指示必须满足才能启用操作的选择计数的值。如果指定了此属性并且满足条件，则启用操作。如果条件不满足，则禁用操作。如果没有指定任何属性，则对选择了任意数目的项启用操作。下列属性格式受支持： ! －选择了零项
   ? －选择了零项或一项
   + －选择了一项或多项
   multiple, 2+ －选择了两项或多项
   n －选择了精确数目的项。例如：nablesFor=" 4" 仅当选择了 4 个项时才启用操作。
   * －选择了任意数目的项

objectContribution形式：


                   id="com.cnfree.open"
            menubarPath="new.ext"
            definitionID="com.cnfree.open.selection"
            label="&Open@Ctrl+O"
            tooltip="Open the selected item(s)"
            helpContextId="com.cnfree.open.selection"
            icon="icon/open.gif"
            class="com.cnfree.action.Op enSelectedActionDelegate"
            enablesFor="+">



action Open实现了IOpenable，这样就意味着，所有包含了IOpenable对象的视图，当我们选中其中的IOpenable对象时，它的弹出菜单都会增加我们自定义的菜单项。

附带的例子：
cnfree editor plugin

使用说明：建立一个Java文件，在它的注释里添加 xxx.yyy ，xxx为一个类名，yyy为一个三位数ID，比如cnfee.100,cnfree.101,cnfree.102，在Java透视图里打开这个Java文件，右键菜单会有一个选项：查找最大ID，打开后输入cnfree，它就会自动找到cnfree.102，并将该字符串高亮显示。

Eclipse插件菜单ID注册表参考：http://www.jdg2e.com/ch21.actions.table/doc/

参考资料：
http://www.eclipsesource.com/EN_ARCHIVE/etips_07072004.html
Eclipse帮助：org.eclipse.platform.doc.isv/guide/workbench_basicext_popupMenus.htm

鬼谷子 2008-02-23 10:37 发表评论

扩展Eclipse视图弹出菜单（二）

鬼谷子 — Sat, 23 Feb 2008 02:29:00 GMT

转自：http://www.blogjava.net/cnfree/archive/2006/06/16/53326.html

上一篇文章我们知道了Eclipse弹出菜单的基本用法。其实Eclipse的弹出菜单可以用来做很多文章，简单一点的根据文件类别，我们可以进行不同的文件操作，比如Ant的build.xml我们可以用来build，Java文件我们可以用Java Editor打开，这些基于文件类型的操作我们都可以很容易的实现。但是还有一种情况，如果文件类型一样，我们想进行不同的操作，该怎么实现呢？实际上这样的应用很多，比如同样是Java文件，含有main方法的Java文件有Run和Debug的选项，其它的都没有。还有现在的框架都是基于XML文件进行配置的，如果一个项目使用了多个框架，我们怎么根据不同的XML文件进行框架的区分呢？答案就是enablement的test。

test EMPTY>
property CDATA #REQUIRED
args CDATA #IMPLIED
value CDATA #IMPLIED>

This element is used to evaluate the property state of the object in focus. The set of testable properties can be extended using the propery tester extension point. The test expression returns EvaluationResult.NOT_LOADED if teh property tester doing the actual testing isn't loaded yet.

property - the name of an object's property to test.
args - additional arguments passed to the property tester. Multiple arguments are seperated by commas. Each individual argument is converted into a Java base type using the same rules as defined for the value attribute of the test expression.
value - the expected value of the property. Can be omitted if the property is a boolean property. The test expression is supposed to return EvaluationResult.TRUE if the property matches the value and EvaluationResult.FALSE otherwise. The value attribute is converted into a Java base type using the following rules:
- the string "true" is converted into Boolean.TRUE
- the string "false" is converted into Boolean.FALSE
- if the string contains a dot then the interpreter tries to convert the value into a Float object. If this fails the string is treated as a java.lang.String
- if the string only consists of numbers then the interpreter converts the value in an Integer object.
- in all other cases the string is treated as a java.lang.String
- the conversion of the string into a Boolean, Float, or Integer can be suppressed by surrounding the string with single quotes. For example, the attribute value="'true'" is converted into the string "true"

比如我们要让含有main方法的Java文件它的右键弹出菜单包含一个额外的选项“This is main class”，需要编写如下的Plugin.xml：

< plugin >
    < extension
          point ="org.eclipse.ui.popupMenus" >
       < objectContribution
         id ="Advanced.PopupMenus"
        objectClass ="java.lang.Object" >
      < action id ="Advanced.PopupMenus.Action"
        label ="AdvancedPopupMenus"
        style ="pulldown"
        menubarPath ="additions"
        class ="advancedpopupmenus.popup.actions.AdvancedPopupMenusAction"
        enablesFor ="+" >
      action >
      < enablement >
           < test property ="advancedpopupmenus.popup.visable" />
      enablement >
      objectContribution >
    extension >
    < extension point ="org.eclipse.core.expressions.propertyTesters" >
    < propertyTester
    namespace ="advancedpopupmenus.popup"
   properties ="visable"
   type ="java.lang.Object"
   class ="advancedpopupmenus.popup.actions.VisablePropertyTester"
   id ="advancedpopupmenus.popup.propertyTesters.visable" >
    propertyTester >
    extension >
plugin >

我们需要检测在当前情况下是否需要显示这个菜单项，使用扩展点 org.eclipse.core.expressions.propertyTesters ：

id         CDATA #REQUIRED
type       CDATA #REQUIRED
namespace CDATA #REQUIRED
properties CDATA #REQUIRED
class      CDATA #REQUIRED>

id - unique identifier for the property tester
type - the type to be extended by this property tester
namespace - a unique id determining the name space the properties are added to
properties - a comma separated list of properties provided by this property tester
class - the name of the class that implements the testing methods. The class must be public and extend org.eclipse.core.expressions.PropertyTester with a public 0-argument constructor.

这里只须注意 propertyTester的namespace和properties正好对应test的property。

至于检测的逻辑我们在advancedpopupmenus.popup.actions.VisablePropertyTester中实现，这个类必须继承自org.eclipse.core.expressions.PropertyTester。

package advancedpopupmenus.popup.actions;

import org.eclipse.core.expressions.PropertyTester;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.core.JavaModelException;
import org.eclipse.jdt.internal.core.CompilationUnit;

public class VisablePropertyTester extends PropertyTester
{
     public boolean test( Object receiver, String property, Object[] args,
            Object expectedValue )
    {
         if ( ! ( receiver instanceof CompilationUnit ) )
             return false ;
        CompilationUnit unit = (CompilationUnit) receiver;
         try
        {
            IType[] types = unit.getTypes( );
             if ( types == null )
                 return false ;
             for ( int i = 0 ; i < types.length; i ++ )
            {
                IMethod[] methods = types[i].getMethods( );
                 if ( methods == null )
                     return false ;
                 for ( int j = 0 ; j < methods.length; j ++ )
                {
                     if ( methods[j].isMainMethod( ) )
                         return true ;
                }
            }
        }
         catch ( JavaModelException e )
        {
            e.printStackTrace( );
        }
         return false ;
    }
}

我们只要判断接受的Java文件中是否含有main方法，如果有，则返回True，没有则返回False。

如果我们是要接受一个Web开发的配置文件，我们可以这样写：

< plugin >
    < extension
          point ="org.eclipse.ui.popupMenus" >
       < objectContribution
         id ="Advanced.PopupMenus"
        objectClass ="org.eclipse.core.resources.IFile"
        nameFilter ="*.xml" >
         < action id ="Advanced.PopupMenus.Action"
           label ="This is web xml"
           style ="pulldown"
           menubarPath ="additions"
           class ="advancedpopupmenus.popup.actions.AdvancedPopupMenusAction"
           enablesFor ="+" >
         action >
         < enablement >
              < test property ="advancedpopupmenus.popup.visable" />
         enablement >
      objectContribution >
    extension >
    < extension point ="org.eclipse.core.expressions.propertyTesters" >
       < propertyTester
             namespace ="advancedpopupmenus.popup"
            properties ="visable"
            type ="org.eclipse.core.resources.IFile"
            class ="advancedpopupmenus.popup.actions.VisablePropertyTester"
            id ="advancedpopupmenus.popup.propertyTesters.visable" >
       propertyTester >
    extension >
plugin >

注意和上一个例子不同的地方，objectClass，nameFileter和type(在上一个例子中，我们也可以使用objectClass="org.eclipse.core.resources.IFile" nameFilter ="*.java" )，相应的我们的VisablePropertyTester类也要做一些改动：

package advancedpopupmenus.popup.actions;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import org.eclipse.core.expressions.PropertyTester;
import org.eclipse.core.resources.IFile;
import org.w3c.dom.Document;
import org.w3c.dom.DocumentType;

public class VisablePropertyTester extends PropertyTester
{
     public boolean test( Object receiver, String property, Object[] args,
            Object expectedValue )
    {
         if ( ! ( receiver instanceof IFile ) )
             return false ;
        IFile xml = (IFile) receiver;
         try
        {
            DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance( );
            DocumentBuilder db = dbf.newDocumentBuilder( );
            Document doc = db.parse( xml.getContents( ) );
            DocumentType type = doc.getDoctype( );
             if (type.getSystemId( ).equalsIgnoreCase( " http://java.sun.com/j2ee/dtds/web-app_2_2.dtd " )) return true ;
        }
         catch ( Exception e )
        {
            e.printStackTrace( );
        }
         return false ;
    }
}

这样根据不同的xml SystemID，我们就能够知道到底这是哪一种框架的配置文件了。

鬼谷子 2008-02-23 10:29 发表评论

方便管理plugin或rcp的icons

鬼谷子 — Wed, 30 Jan 2008 09:24:00 GMT

转自：http://blog.csdn.net/moneyice/archive/2006/04/25/677423.aspx

每个UI程序都离不开图片，一般的Eclipse插件，在一个类中定义了若干静态常量，每一个常量指定一个icon的名字，在程序中用到图片的时候，通过这个常量计算得到图片。Eclipse的插件一般规模较大，图片很多，而且分不同的像素，彩色，灰白等。这样有利于统一的管理和开发人员的沟通。

但并不是每个plugin或者rcp都要用到这么多图片，如果只有很少的图片的话，可以用图片的名字作为key,来存取图片。程序例子如下：

public class ImageShop {

private static ImageRegistry register = new ImageRegistry();

private static Set keys = new HashSet();

static {

initial();

}

public static ImageDescriptor getDescriptor(String key) {

ImageDescriptor image = register.getDescriptor(key);

if (image == null) {

image = ImageDescriptor.getMissingImageDescriptor();

}

return image;

}

public static Image get(String key) {

Image image = register.get(key);

if (image == null) {

image = ImageDescriptor.getMissingImageDescriptor().createImage();

}

return image;

}

public static String[] getImageKey() {

return (String[]) keys.toArray(new String[keys.size()]);

}

private static void initial() {

Bundle bundle = Platform.getBundle(PwdgatePlugin.ID);

URL url = bundle.getEntry("icons");

try {

url = Platform.asLocalURL(url);

} catch (Exception e) {

PwdgatePlugin.log("get root path", e);

}

File file = new File(url.getPath());

File[] images = file.listFiles();

for (int i = 0; i < images.length; i++) {

File f = images[i];

if (!f.isFile()) {

continue;

}

String name = f.getName();

if (!name.endsWith(".gif")) {

continue;

}

String key = name.substring(0, name.indexOf('.'));

URL fullPathString = bundle.getEntry("icons/" + name);

ImageDescriptor des = ImageDescriptor.createFromURL(fullPathString);

keys.add(key);

}

所有的图片都放在根目录/icons目录下，在系统中如果用到名字为default.gif的图片，只要调用ImageShop.get(“default”)即可；有时在Action中需要用到ImageDescriptor，调用ImageShop. getDescriptor(“default”)就可以取到。

鬼谷子 2008-01-30 17:24 发表评论