使用Eclipse RCP进行桌面程序开发（二）：菜单、工具栏和对话框

比眉伴天荒 2022-08-13 16:43 298阅读 0赞

在[使用Eclipse RCP进行桌面程序开发（一）：快速起步][Eclipse RCP]中，我们通过Eclipse的插件开发向导，逐步建立了一个RCP应用程序，但是，这个程序没有任何功能，难以激起我们学习的兴趣。在这一节，我们将一起探索怎样在程序中添加菜单和工具条。先看一下成果：

图一、图二：带有菜单和工具条的RCP程序  
![rcp18.JPG][]  
  
![rcp19.JPG][]

图三：工具栏上的按钮的提示文本  
![rcp20.JPG][]

图四：点击菜单项或者工具栏按钮后，弹出一个简单的对话框。  
![rcp21.JPG][]

这里需要说明一点，为什么要在讲菜单和工具栏的时候一起讲对话框，这是因为对话框是我们所能想到的最简单最直接的用户交互方式，在对话框上可以添加各种各样的控件来实现复杂的功能，为了让我们点击菜单项的时候能够看到效果，这里就用了一个简单的对话框。当然，当我们以后接触到视图、编辑器和透视图这样的概念之后，我们能使用的用户交互方式就不仅仅只是对话框了。

打开我们上一节使用向导建立的工程，可以发现工程下面自动生成了如下文件：  
Application.java  
ApplicationWorkbenchAdvisor.java  
ApplicationWorkbenchWindowAdvisor.java  
ApplicationActionBarAdvisor.java  
Perspective.java  
plugin.xml  
这里的Application.java是我们整个程序的入口点，我们的程序运行的时候，会先执行Application的run方法，run方法的代码如下：

1  ![ExpandedBlockStart.gif][]  public  Object run(Object args)   throws  Exception   \{  
 2 ![InBlock.gif][]        Display display  =  PlatformUI.createDisplay();  
 3 ![ExpandedSubBlockStart.gif][]          try   \{  
 4 ![InBlock.gif][]             int  returnCode  =  PlatformUI.createAndRunWorkbench(display,  new  ApplicationWorkbenchAdvisor());  
 5 ![ExpandedSubBlockStart.gif][]              if  (returnCode  ==  PlatformUI.RETURN\_RESTART)  \{  
 6 ![InBlock.gif][]                 return  IPlatformRunnable.EXIT\_RESTART;  
 7 ![ExpandedSubBlockEnd.gif][]            \}   
 8 ![InBlock.gif][]             return  IPlatformRunnable.EXIT\_OK;  
 9 ![ExpandedSubBlockStart.gif][]         \}   finally   \{  
10 ![InBlock.gif][]            display.dispose();  
11 ![ExpandedSubBlockEnd.gif][]        \}   
12 ![ExpandedBlockEnd.gif][]    \}

在第4行我们可以看出，该入口函数将创建用户界面的工作交给了ApplicationWorkbenchAdvisor类。接着，我们打开ApplicationWorkbenchAdvisor.java，代码如下：

1  ![ExpandedBlockStart.gif][]  public    class  ApplicationWorkbenchAdvisor   extends  WorkbenchAdvisor   \{  
 2 ![InBlock.gif][]   
 3 ![InBlock.gif][]     private   static   final  String PERSPECTIVE\_ID  =   " cn.blogjava.youxia.rcp\_start.perspective " ;  
 4 ![InBlock.gif][]   
 5 ![ExpandedSubBlockStart.gif][]      public  WorkbenchWindowAdvisor createWorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer)  \{  
 6 ![InBlock.gif][]         return   new  ApplicationWorkbenchWindowAdvisor(configurer);  
 7 ![ExpandedSubBlockEnd.gif][]    \}   
 8 ![InBlock.gif][]   
 9 ![ExpandedSubBlockStart.gif][]      public  String getInitialWindowPerspectiveId()  \{  
10 ![InBlock.gif][]         return  PERSPECTIVE\_ID;  
11 ![ExpandedSubBlockEnd.gif][]    \}   
12 ![ExpandedBlockEnd.gif][]\}

可以看出，这个类的工作就是为我们的程序指定默认的透视图，然后把创建窗口的工作交给了ApplicationWorkbenchWindowAdvisor类。接着，我们打开ApplicationWorkbenchWindowAdvisor.java文件，看到代码如下：

1  ![ExpandedBlockStart.gif][]  public    class  ApplicationWorkbenchWindowAdvisor   extends  WorkbenchWindowAdvisor   \{  
 2 ![InBlock.gif][]   
 3 ![ExpandedSubBlockStart.gif][]      public  ApplicationWorkbenchWindowAdvisor(IWorkbenchWindowConfigurer configurer)  \{  
 4 ![InBlock.gif][]         super (configurer);  
 5 ![ExpandedSubBlockEnd.gif][]    \}   
 6 ![InBlock.gif][]   
 7 ![ExpandedSubBlockStart.gif][]      public  ActionBarAdvisor createActionBarAdvisor(IActionBarConfigurer configurer)  \{  
 8 ![InBlock.gif][]         return   new  ApplicationActionBarAdvisor(configurer);  
 9 ![ExpandedSubBlockEnd.gif][]    \}   
10 ![InBlock.gif][]      
11 ![ExpandedSubBlockStart.gif][]      public   void  preWindowOpen()  \{  
12 ![InBlock.gif][]        IWorkbenchWindowConfigurer configurer  =  getWindowConfigurer();  
13 ![InBlock.gif][]        configurer.setInitialSize( new  Point( 600 ,  450 ));  
14 ![InBlock.gif][]        configurer.setShowCoolBar( true );  
15 ![InBlock.gif][]        configurer.setShowStatusLine( false );  
16 ![InBlock.gif][]        configurer.setTitle( " 第一个RCP程序 " );  
17 ![InBlock.gif][]          
18 ![ExpandedSubBlockEnd.gif][]    \}   
19 ![InBlock.gif][]         
20 ![ExpandedBlockEnd.gif][]\}

这个类的功能很强大，我们可以重载它的preWindowCreate、postWindowCreate、preWindowOpen、postWindowOpen等方法，以便修改我们窗口的外观。在这里可以看出，我们重载了preWindowOpen方法来设置窗口的大小和让工具栏可见。很显然，这个类的另外一个功能，就是把创建菜单和工具栏的任务交给了ApplicationActionBarAdvisor类。

到这里，谜底已经揭晓，要创建我们自己的菜单和工具条，就一定是在ApplicationActionBarAdvisor.java中做文章了。不错，打开这个文件，我们可以看到这个类有两个重要的方法：  
protected void makeActions(IWorkbenchWindow window);  
protected void fillMenuBar(IMenuManager menuBar);  
我们可以在makeActions方法中创建我们的Action，什么是Action呢？Action是jface中的一个概念，在jface中通过org.eclipse.jface.action中的Action和ActionContributionItem类实现了视图和处理代码的分离，这样无论何时用户触发了一个控件的事件，都会激活一个相应的Action类实例来进行时间处理。毫无疑问，我们的菜单项是一个Action类的子类了。

下面请看ApplicationActionBarAdvisor.java的源代码：

1  ![None.gif][]  package  cn.blogjava.youxia.rcp\_start;  
 2  ![None.gif][]   
 3  ![None.gif][]  import  org.eclipse.jface.action.IMenuManager;  
 4  ![None.gif][]  import  org.eclipse.jface.action.MenuManager;  
 5  ![None.gif][]  import  org.eclipse.ui.IWorkbenchWindow;  
 6  ![None.gif][]  import  org.eclipse.ui.application.ActionBarAdvisor;  
 7  ![None.gif][]  import  org.eclipse.ui.application.IActionBarConfigurer;  
 8  ![None.gif][]  import  org.eclipse.ui.actions.ActionFactory.IWorkbenchAction;  
 9  ![None.gif][]  import  cn.blogjava.youxia.actions.Action1;  
10  ![None.gif][]   
11  ![ExpandedBlockStart.gif][]  public    class  ApplicationActionBarAdvisor   extends  ActionBarAdvisor   \{  
12 ![InBlock.gif][]      
13 ![InBlock.gif][]     private  IWorkbenchAction action1;  
14 ![InBlock.gif][]   
15 ![ExpandedSubBlockStart.gif][]      public  ApplicationActionBarAdvisor(IActionBarConfigurer configurer)  \{  
16 ![InBlock.gif][]         super (configurer);  
17 ![ExpandedSubBlockEnd.gif][]    \}   
18 ![InBlock.gif][]   
19 ![ExpandedSubBlockStart.gif][]      protected   void  makeActions(IWorkbenchWindow window)  \{  
20 ![InBlock.gif][]        action1  =   new  Action1(window);  
21 ![InBlock.gif][]        action1.setText( " 第一个菜单项 " );  
22 ![InBlock.gif][]        action1.setId( " cn.blogjava.youxia.actions.action1 " );  
23 ![InBlock.gif][]        register(action1);  
24 ![ExpandedSubBlockEnd.gif][]    \}   
25 ![InBlock.gif][]   
26 ![ExpandedSubBlockStart.gif][]      protected   void  fillMenuBar(IMenuManager menuBar)  \{  
27 ![InBlock.gif][]        MenuManager newMenu  =   new  MenuManager( " 第一个菜单 " , " cn.blogjava.youxia.firstmenu " );  
28 ![InBlock.gif][]        menuBar.add(newMenu);  
29 ![InBlock.gif][]        newMenu.add(action1);  
30 ![ExpandedSubBlockEnd.gif][]    \}   
31 ![InBlock.gif][]     
32 ![ExpandedBlockEnd.gif][]\}

可以看出，我们通过创建cn.blogjava.youxia.actions.Action1类的实例来创建一个菜单项，然后把它加入到菜单newMenu中，然后再把newMenu加入menuBar中，整个过程很容易理解。那么register(action1)是做什么的呢？这是为了把我们的Action的实例注册到工作台中，这样当我们的工作台销毁的时候，我们的Action也可以被销毁。

下面请看Action1类的源代码：

1  ![None.gif][]  package  cn.blogjava.youxia.actions;  
 2  ![None.gif][]   
 3  ![None.gif][]  import  org.eclipse.jface.action.Action;  
 4  ![None.gif][]  import  org.eclipse.ui.IWorkbenchWindow;  
 5  ![None.gif][]  import  org.eclipse.ui.actions.ActionFactory.IWorkbenchAction;  
 6  ![None.gif][]  import  cn.blogjava.youxia.rcp\_start.FirstDialog;  
 7  ![None.gif][]   
 8  ![None.gif][]   
 9  ![ExpandedBlockStart.gif][]  public    class  Action1   extends  Action   implements  IWorkbenchAction   \{  
10 ![InBlock.gif][]      
11 ![InBlock.gif][]     private  IWorkbenchWindow workbenchWindow;  
12 ![InBlock.gif][]   
13 ![ExpandedSubBlockStart.gif][]      public  Action1(IWorkbenchWindow window)  \{  
14 ![ExpandedSubBlockStart.gif][]          if  (window  ==   null )  \{  
15 ![InBlock.gif][]             throw   new  IllegalArgumentException();  
16 ![ExpandedSubBlockEnd.gif][]        \}   
17 ![InBlock.gif][]   
18 ![InBlock.gif][]         this .workbenchWindow  =  window;  
19 ![ExpandedSubBlockEnd.gif][]    \}   
20 ![InBlock.gif][]      
21 ![ExpandedSubBlockStart.gif][]      public   void  run()  \{  
22 ![InBlock.gif][]         //  make sure action is not disposed   
23 ![ExpandedSubBlockStart.gif][]          if  (workbenchWindow  !=   null )  \{  
24 ![InBlock.gif][]             // 在这里添加功能   
25 ![InBlock.gif][]             FirstDialog dg  =   new  FirstDialog(workbenchWindow.getShell());  
26 ![InBlock.gif][]            dg.open();  
27 ![InBlock.gif][]              
28 ![ExpandedSubBlockEnd.gif][]        \}   
29 ![ExpandedSubBlockEnd.gif][]    \}   
30 ![InBlock.gif][]   
31 ![ExpandedSubBlockStart.gif][]      public   void  dispose()  \{  
32 ![InBlock.gif][]        workbenchWindow  =   null ;  
33 ![InBlock.gif][]   
34 ![ExpandedSubBlockEnd.gif][]    \}   
35 ![InBlock.gif][]   
36 ![ExpandedBlockEnd.gif][]\}

在构造函数中保存我们工作台窗口的引用，在run方法中执行功能，是不是很简单？在这里，我们用到了一个对话框类cn.blogjava.youxia.rcp\_start.FirstDialog，这个类从org.eclipse.swt.widgets.Dialog类继承，熟悉swt的朋友一定不会陌生。我建议大家可以使用Designer插件，这个插件对swt/jface提供非常好的可视化支持，在这个对话框中，我们只简单的添加了两个按钮。

FirstDialog.java源文件如下：

1  ![None.gif][]  package  cn.blogjava.youxia.rcp\_start;  
 2  ![None.gif][]   
 3  ![None.gif][]  import  org.eclipse.swt.SWT;  
 4  ![None.gif][]  import  org.eclipse.swt.events.SelectionAdapter;  
 5  ![None.gif][]  import  org.eclipse.swt.events.SelectionEvent;  
 6  ![None.gif][]  import  org.eclipse.swt.widgets.Button;  
 7  ![None.gif][]  import  org.eclipse.swt.widgets.Dialog;  
 8  ![None.gif][]  import  org.eclipse.swt.widgets.Display;  
 9  ![None.gif][]  import  org.eclipse.swt.widgets.Shell;  
10  ![None.gif][]   
11  ![None.gif][]   
12  ![ExpandedBlockStart.gif][]  public    class  FirstDialog   extends  Dialog   \{  
13 ![InBlock.gif][]   
14 ![InBlock.gif][]     protected  Shell shell;  
15 ![InBlock.gif][]      
16 ![InBlock.gif][]     private   int  result;  
17 ![InBlock.gif][]   
18 ![ExpandedSubBlockStart.gif][]      public  FirstDialog(Shell parent,  int  style)  \{  
19 ![InBlock.gif][]         super (parent, style);  
20 ![ExpandedSubBlockEnd.gif][]    \}   
21 ![InBlock.gif][]   
22 ![ExpandedSubBlockStart.gif][]      public  FirstDialog(Shell parent)  \{  
23 ![InBlock.gif][]         this (parent, SWT.NONE);  
24 ![ExpandedSubBlockEnd.gif][]    \}   
25 ![InBlock.gif][]   
26 ![ExpandedSubBlockStart.gif][]      public   int  open()  \{  
27 ![InBlock.gif][]        createContents();  
28 ![InBlock.gif][]        shell.open();  
29 ![InBlock.gif][]        shell.layout();  
30 ![InBlock.gif][]        Display display  =  getParent().getDisplay();  
31 ![ExpandedSubBlockStart.gif][]          while  ( ! shell.isDisposed())  \{  
32 ![InBlock.gif][]             if  ( ! display.readAndDispatch())  
33 ![InBlock.gif][]                display.sleep();  
34 ![ExpandedSubBlockEnd.gif][]        \}   
35 ![InBlock.gif][]         return  result;  
36 ![ExpandedSubBlockEnd.gif][]    \}   
37 ![InBlock.gif][]   
38 ![ExpandedSubBlockStart.gif][]      protected   void  createContents()  \{  
39 ![InBlock.gif][]        shell  =   new  Shell(getParent(), SWT.DIALOG\_TRIM  |  SWT.APPLICATION\_MODAL);  
40 ![InBlock.gif][]        shell.setSize( 150 ,  70 );  
41 ![InBlock.gif][]        shell.setText( " 第一个对话框 " );  
42 ![InBlock.gif][]   
43 ![InBlock.gif][]         final  Button okButton  =   new  Button(shell, SWT.NONE);  
44 ![ExpandedSubBlockStart.gif][]         okButton.addSelectionListener( new  SelectionAdapter()  \{  
45 ![ExpandedSubBlockStart.gif][]              public   void  widgetSelected(SelectionEvent e)  \{  
46 ![InBlock.gif][]                result  =   1 ;  
47 ![InBlock.gif][]                shell.dispose();  
48 ![ExpandedSubBlockEnd.gif][]            \}   
49 ![ExpandedSubBlockEnd.gif][]        \} );  
50 ![InBlock.gif][]        okButton.setText( " OK " );  
51 ![InBlock.gif][]        okButton.setBounds( 10 ,  10 ,  48 ,  22 );  
52 ![InBlock.gif][]   
53 ![InBlock.gif][]         final  Button cancelButton  =   new  Button(shell, SWT.NONE);  
54 ![ExpandedSubBlockStart.gif][]         cancelButton.addSelectionListener( new  SelectionAdapter()  \{  
55 ![ExpandedSubBlockStart.gif][]              public   void  widgetSelected(SelectionEvent e)  \{  
56 ![InBlock.gif][]                result  =   2 ;  
57 ![InBlock.gif][]                shell.dispose();  
58 ![ExpandedSubBlockEnd.gif][]            \}   
59 ![ExpandedSubBlockEnd.gif][]        \} );  
60 ![InBlock.gif][]        cancelButton.setText( " Cancel " );  
61 ![InBlock.gif][]        cancelButton.setBounds( 89 ,  10 ,  48 ,  22 );  
62 ![ExpandedSubBlockEnd.gif][]    \}   
63 ![InBlock.gif][]   
64 ![ExpandedBlockEnd.gif][]\}   
65  ![None.gif][]

上面所讲的，只是添加菜单和工具栏的第一种方法，这种方法把构建菜单的工作以静态代码的方式加入到了ApplicationActionBarAdvisor类中，如果需要修改用户界面，则需要修改代码并重新编译。

添加菜单项的第二种方法就要简单得多，而且修改起来也方便，还可以对菜单项实现更加灵活的控制，但是，需要对Eclipse的插件基础有比较好的了解。那这第二种方法就是通过扩展actionSets扩展点来添加菜单。

对扩展点的扩展，可以通过编辑plugin.xml文件了实现，比如我们添加的第二个菜单项，其配置文件如下：

1  ![None.gif][]  <  extension  
  2  ![None.gif][]           id  ="cn.blogjava.youxia.actionset"    
  3  ![None.gif][]         name  ="我的菜单扩展"    
  4  ![None.gif][]         point  ="org.eclipse.ui.actionSets"  >   
 5  ![None.gif][]        <  actionSet  
  6  ![None.gif][]              description  ="第一个扩展"    
  7  ![None.gif][]            id  ="RCP\_Start.actionSet1"    
  8  ![None.gif][]            label  ="RCP\_Start.actionSet1"    
  9  ![None.gif][]            visible  ="true"  >   
10  ![None.gif][]           <  action  
 11  ![None.gif][]                 class  ="cn.blogjava.youxia.actions.Action2"    
 12  ![None.gif][]               icon  ="icons/alt\_window\_16.gif"    
 13  ![None.gif][]               id  ="RCP\_Start.action2"    
 14  ![None.gif][]               label  ="第二个菜单项"    
 15  ![None.gif][]               menubarPath  ="cn.blogjava.youxia.firstmenu/additions"    
 16  ![None.gif][]               style  ="push"    
 17  ![None.gif][]               toolbarPath  ="additions"    
 18  ![None.gif][]               tooltip  ="第二个菜单项的按钮"  />   
19  ![None.gif][]        </  actionSet  >   
20  ![None.gif][]     </  extension  >

其实Eclipse为我们提供了很好的可视化plugin.xml的编辑器，如下图，我们可以对菜单的外观进行和行为进行灵活的控制：

![rcp22.JPG][]

从配置文件中我们可以看到，我们为这第二个菜单项指定的Action是cn.blogjava.youxia.actions.Action2类，这个类我们必须实现org.eclipse.ui.IWorkbenchWindowActionDelegate接口，这个接口中比org.eclipse.jface.actions.Action中多定义了一个方法public void selectionChanged(IAction action, ISelection selection)，这个方法是必须的，以便工作台窗口在用户选定哪一项资源的时候通知我们的Action类的实例。其代码如下：

1  ![None.gif][]  package  cn.blogjava.youxia.actions;  
 2  ![None.gif][]   
 3  ![None.gif][]  import  org.eclipse.jface.action.IAction;  
 4  ![None.gif][]  import  org.eclipse.jface.viewers.ISelection;  
 5  ![None.gif][]  import  org.eclipse.ui.IWorkbenchWindow;  
 6  ![None.gif][]  import  org.eclipse.ui.IWorkbenchWindowActionDelegate;  
 7  ![None.gif][]  import  cn.blogjava.youxia.rcp\_start.FirstDialog;  
 8  ![None.gif][]   
 9  ![ExpandedBlockStart.gif][]  public    class  Action2   implements  IWorkbenchWindowActionDelegate   \{  
10 ![InBlock.gif][]      
11 ![InBlock.gif][]     private  IWorkbenchWindow window;  
12 ![InBlock.gif][]   
13 ![ExpandedSubBlockStart.gif][]      public   void  dispose()  \{  
14 ![InBlock.gif][]         //  TODO    
15 ![InBlock.gif][]   
16 ![ExpandedSubBlockEnd.gif][]    \}   
17 ![InBlock.gif][]   
18 ![ExpandedSubBlockStart.gif][]      public   void  init(IWorkbenchWindow window)  \{  
19 ![InBlock.gif][]         //  TODO    
20 ![InBlock.gif][]          this .window  =  window;  
21 ![InBlock.gif][]   
22 ![ExpandedSubBlockEnd.gif][]    \}   
23 ![InBlock.gif][]   
24 ![ExpandedSubBlockStart.gif][]      public   void  run(IAction action)  \{  
25 ![InBlock.gif][]         //  TODO    
26 ![InBlock.gif][]         FirstDialog dg  =   new  FirstDialog(window.getShell());  
27 ![InBlock.gif][]        dg.open();  
28 ![InBlock.gif][]   
29 ![ExpandedSubBlockEnd.gif][]    \}   
30 ![InBlock.gif][]   
31 ![ExpandedSubBlockStart.gif][]      public   void  selectionChanged(IAction action, ISelection selection)  \{  
32 ![InBlock.gif][]         //  TODO    
33 ![InBlock.gif][]   
34 ![ExpandedSubBlockEnd.gif][]    \}   
35 ![InBlock.gif][]   
36 ![ExpandedBlockEnd.gif][]\}

总结：通过向工作台中添加菜单和工具栏，并使用对话框作为与用户交互的基础，我们已经基本上可以构建功能比较复杂的程序了。但这仅仅只是RCP编程的开端。下一节，我们将一起探索Eclipse的透视图和视图。

[Eclipse RCP]: http://www.blogjava.net/youxia/archive/2006/11/17/81852.html
[rcp18.JPG]: /images/20220810/7a57a820dc0f4d9faeb700b78bb558da.png
[rcp19.JPG]: /images/20220810/be3156a2d5634f3583683b95f4e3441e.png
[rcp20.JPG]: /images/20220810/444f3d9bd2844bb790b5fe1062813833.png
[rcp21.JPG]: /images/20220810/c8cddfdee3e1440187e6c47080566270.png
[ExpandedBlockStart.gif]: /images/20220810/0b8d7c7fb02244598c7f30ccb17edc3d.png
[InBlock.gif]: /images/20220810/b934294333a94e4ead49036c2da044cb.png
[ExpandedSubBlockStart.gif]: /images/20220810/1d38c575eae14163a2c561a259b5dd86.png
[ExpandedSubBlockEnd.gif]: /images/20220810/fd26a772ee8040f1ba85dcb32f0b10ea.png
[ExpandedBlockEnd.gif]: /images/20220810/d05aa853df3541d091b17154233ab372.png
[None.gif]: /images/20220810/6c1b7b7f60b4492ebeceb52af7106a54.png
[rcp22.JPG]: /images/20220810/09bc1ddf4a8b48629bc0696aaa35f1a6.png