`
LuChar
  • 浏览: 74918 次
  • 性别: Icon_minigender_1
  • 来自: 成都
社区版块
存档分类
最新评论

Rich Client Tutorial Part 3 翻译

    博客分类：
  • RCP
EclipseUIIDEXML编程 
阅读更多

前言

        这是我第一次翻译技术性的文章，若有不正之处，请同行们多加指正。我个人认为翻译没有必要逐字逐句的进行，我的原则是：根据自己在实战方面的理解，尽可能的把原理讲清楚而又不失去原作的本意，同时加入自己的见解。

在自己的应用程序中使用RCP，能让我们重用Eclipse IDE的基本功能。部分1和部分2通过一个非常简单的，只打开一个空窗口的例子向你介绍了这个平台。部分3将向你介绍一个更加复杂点的，带有菜单、视图和其它特性的例子。

介绍

        前两部分通过一个简单的应用阐述了RCP(Rich Client Platform)的基本概念。我们使用了Eclipse SDK提供的一个叫“Hello RCP”的插件项目模板。现在我们将深入探讨一个复杂的应用。我们能向应用程序中一次添加一样东西，但实际上这不是最好的办法。
当你自己写应用程序时，最快的办法是找一个模板或其它和你要创建的应用相类似的程序，然后拷贝。这也是我要使用的办法，使用一个叫“RCP Mail”的模板。在该教程的结尾有你需要理解掌握的信息，包含了该例子是如何工作的，然后你就可以基于此创建你自己的应用了。

RCP Mail template

这个RCP Mail 模板不是一个真正功能性的mail应用程序，但却是一个独立的RCP例子，教我们如何：
  • 通过actions添加顶层菜单和工具栏
  • 通过actions添加键盘绑定(keybindings )
  • 创建不可关闭的视图和多个相同实例的视图
  • 用placeholders为新的视图创建透视图
  • 使用默认的About对话框
  • 创建一个产品定义(product definition)

想第一部分一样，选择 File > New > Project, 展开Plug-in Development 然后再选择 Plug-in Project 打开一个插件项目创建向导.输入项目的名字，如 org.eclipse.ui.tutorials.rcp.part3,

在选择"Would you like to create a rich client application?"时选择 Yes. 然后点击下一步，选择RCP Mail Template后点击Finish

Note:

Figure 1. 通过RCP Mail Template生成的实例可以作为你自己RCP应用的骨架使用。

在Plug-in Manifest属性页中点击"Launch an Eclipse application"测试该应用，如果成功就会看到下面的图：

Views

RCP Mail 有两个视图，左边展示的是mail消息，右边是特定的mail消息。这些views都是通过org.eclipse.ui.views扩展点扩展而来，是在plugin.xml 中定义。 Listing 1 展示了 Message view的定义：

Listing 1. Message view defined in plugin.xml

   
         point="org.eclipse.ui.views">
      
            name="Message"
            allowMultiple="true"
            icon="icons/sample2.gif"
            class="org.eclipse.ui.tutorials.rcp.part3.View"
            id="org.eclipse.ui.tutorials.rcp.part3.view">

视图的标题栏使用的是一个文件名为sample2.gif 的16x16 icon的GIF图片。属性的说明如下：

id：仅仅是该视图的一个唯一标识符

class：详细指定了给视图的全称(包含包路径的view类)

allowMultiple：值为true表示一个特定的类型允许有多个视图，Eclipse默认只有一个

视图类 View 继承了抽象类 org.eclipse.ui.part.ViewPart. Listing 2中显示了部分代码. 只需要实现createPartControl() 和 setFocus() 方法。

Listing 2. View.java

public class View extends ViewPart {

#1 public static final String ID = "org.eclipse.ui.tutorials.rcp.part3.view";

#2 public void createPartControl(Composite parent) {
Composite top = new Composite(parent, SWT.NONE);
...etc...
}

public void setFocus() {
}
}

Notes:

#1 定义了一个ID常量，ID_模式在Eclipse源代码中随处可见。这里使用的ID和plug-in manifest中的id是一样的，当我们需要获得该视图时需要用到该ID。
#2 createPartControl 方法是该类中最重要的方法. 在这里需要创建视图中需要的 JFace 或 SWT 控件. 关于View编程不在该教程讨论之列，但在引用部分有一些资源可供你学习。

你也许会奇怪，Eclipse是如何知道把Mailbox视图放在左边，而把Messages放在右边？这就需要用到透视图Perspective了。

透视图Perspectives

Views 和editors只能显示在 perspective中.， 可以在plugin.xml中通过扩展 org.eclipse.ui.perspectives 来定义透视图. The initial layout for it (i.e., what parts it starts up with) is set up in code. Listing 3 展示了RCP Mail application中的初始化布局代码 。

Listing 3. Perspective.java

java 代码
  1. package org.eclipse.ui.tutorials.rcp.part3;
  3. import org.eclipse.ui.IFolderLayout;
  4. import org.eclipse.ui.IPageLayout;
  5. import org.eclipse.ui.IPerspectiveFactory;
  7. public class Perspective implements IPerspectiveFactory {
  9. public void createInitialLayout(IPageLayout layout) {
  10. #1 String editorArea = layout.getEditorArea();
  11. layout.setEditorAreaVisible(false);
  13. #2 layout.addStandaloneView(NavigationView.ID, false, IPageLayout.LEFT, 0.25f, editorArea);
  14. #3 IFolderLayout folder = layout.createFolder("messages", IPageLayout.TOP, 0.5f, editorArea);
  15. folder.addPlaceholder(View.ID + ":*");
  16. folder.addView(View.ID);
  18. #4 layout.getViewLayout(NavigationView.ID).setCloseable(false);
  19. }
  20. }

注意:

#1 因为该例子没有使用到编辑器，所以在你关闭编辑器后在工作台窗口的中间不会看到一大片空白。如果你使用了编辑器，则删除该行。
#2 该 行在透视图中添加Navigation视图，默认是可见的。 这是一个独立的视图，意味着它不能和其它视图相互折叠，同时没有标题栏。代表位置的参数指定了视图显示在编辑器区域的左边，占据工作台窗口水平区域的 1/4。你也许很奇怪，因为我们没有使用编辑器区域，但它好像隐藏在某处，即使它是不可见的。
#3 还记得我们什么时候创建的Messages视图吗，它使用的 allowMultiple="true"吗? 这意味着你不能确定Messages视图的位置，因为它们不只一个。所以首先你需要为它们创建一个folder，然后调用addPlaceholder() 方法把folder与和Message 视图标识id相匹配的pattern 联系起来. 最后调用 addView() 添加视图. 在一个真实的应用中你也许要记住哪个message先被打开，以便在程序重启后重新打开。
#4 设置Navigation视图不能关闭

Tip: 为了在下次启动应用时恢复用户的布局和窗口的大小，需要在WorkbenchAdvisor中添加configurer.setSaveAndRestore(true); 到initialize()方法中。

Unclosable 和unmoveable views

默认的视图是可以拖动、改变大小和可关闭的。但有时你不想那么的灵活，例如，你正在为用户开发一个订单应用程序，你不想回答那些意外关闭表单页面的请求，这时该如何做呢？基于次原因Eclipse平台提出了确定的透视图和不可关闭/不可拖动视图的概念。

RCP Mail 例子通过使用setCloseable()方法来设置导航器Navigation为不可关闭。但更好的方法是使用一个固定的透视图。一个固定的透视图可以使它所包含的所以视图不可关闭，阻止它们被拖动或被改变大小。为了固定透视图，你可以在createInitialLayout()内部调用通过layout的setFixed(true)方法，或者直接在plugin.xml文件中添加fixed="true"属性。

通过使用固定的透视图，你能将用户锁定在一个透视图中，同时把所有有关透视图的概念一起隐藏。

Menus 和 Toolbars

让人们配置所以的菜单和工具条是只是其中一项，是RCP平台最基本的部分。有两种方式在RCP应用中添加菜单和工具条：

  • 扩展 ActionBarAdvisor 类
  • 在plug-in manifest中使用org.eclipse.ui.actionSets extension

扩展ActionBarAdvisor 是引用内置Workbench actions的唯一办法, 所以该例使用了这一方式。如果你想在一个独立的RCP应用中和Eclipse IDE的插件中用相同的代码，最有效的方式还是进可能多的用 org.eclipse.ui.actionSets 。

Note: Actions, commands, menus, and toolbars 在Eclipse 3.2 或 3.3 中可能被重构了，所以该文很有可能会改变。

Listing 4. ApplicationActionBarAdvisor.java

java 代码
  1. package org.eclipse.ui.tutorials.rcp.part3;
  3. import org.eclipse.jface.action.Action;
  4. import org.eclipse.jface.action.GroupMarker;
  5. import org.eclipse.jface.action.ICoolBarManager;
  6. import org.eclipse.jface.action.IMenuManager;
  7. import org.eclipse.jface.action.IToolBarManager;
  8. import org.eclipse.jface.action.MenuManager;
  9. import org.eclipse.jface.action.Separator;
  10. import org.eclipse.jface.action.ToolBarContributionItem;
  11. import org.eclipse.jface.action.ToolBarManager;
  12. import org.eclipse.swt.SWT;
  13. import org.eclipse.ui.IWorkbenchActionConstants;
  14. import org.eclipse.ui.IWorkbenchWindow;
  15. import org.eclipse.ui.actions.ActionFactory;
  16. import org.eclipse.ui.actions.ActionFactory.IWorkbenchAction;
  17. import org.eclipse.ui.application.ActionBarAdvisor;
  18. import org.eclipse.ui.application.IActionBarConfigurer;
  20. /**
  21. * An action bar advisor is responsible for creating, adding, and disposing of the
  22. * actions added to a workbench window. Each window will be populated with
  23. * new actions.
  24. */
  25. public class ApplicationActionBarAdvisor extends ActionBarAdvisor {
  27. // Actions - important to allocate these only in makeActions, and then use them
  28. // in the fill methods. This ensures that the actions aren't recreated
  29. // when fillActionBars is called with FILL_PROXY.
  30. private IWorkbenchAction exitAction;
  31. private IWorkbenchAction aboutAction;
  32. private IWorkbenchAction newWindowAction;
  33. private OpenViewAction openViewAction;
  34. private Action messagePopupAction;
  37. public ApplicationActionBarAdvisor(IActionBarConfigurer configurer) {
  38. super(configurer);
  39. }
  41. #1 protected void makeActions(final IWorkbenchWindow window) {
  42. // Creates the actions and registers them.
  43. // Registering is needed to ensure that key bindings work.
  44. // The corresponding commands keybindings are defined in the plugin.xml file.
  45. // Registering also provides automatic disposal of the actions when
  46. // the window is closed.
  48. exitAction = ActionFactory.QUIT.create(window);
  49. register(exitAction);
  51. aboutAction = ActionFactory.ABOUT.create(window);
  52. register(aboutAction);
  54. newWindowAction = ActionFactory.OPEN_NEW_WINDOW.create(window);
  55. register(newWindowAction);
  57. openViewAction = new OpenViewAction(window, "Open Another Message View", View.ID);
  58. register(openViewAction);
  60. messagePopupAction = new MessagePopupAction("Open Message", window);
  61. register(messagePopupAction);
  62. }
  64. #2 protected void fillMenuBar(IMenuManager menuBar) {
  65. MenuManager fileMenu = new MenuManager("&File", IWorkbenchActionConstants.M_FILE);
  66. MenuManager helpMenu = new MenuManager("&Help", IWorkbenchActionConstants.M_HELP);
  68. menuBar.add(fileMenu);
  69. // Add a group marker indicating where action set menus will appear.
  70. menuBar.add(new GroupMarker(IWorkbenchActionConstants.MB_ADDITIONS));
  71. menuBar.add(helpMenu);
  73. // File
  74. fileMenu.add(newWindowAction);
  75. fileMenu.add(new Separator());
  76. fileMenu.add(messagePopupAction);
  77. fileMenu.add(openViewAction);
  78. fileMenu.add(new Separator());
  79. fileMenu.add(exitAction);
  81. // Help
  82. helpMenu.add(aboutAction);
  83. }
  85. #3 protected void fillCoolBar(ICoolBarManager coolBar) {
  86. IToolBarManager toolbar = new ToolBarManager(SWT.FLAT | SWT.RIGHT);
  87. coolBar.add(new ToolBarContributionItem(toolbar, "main"));
  88. toolbar.add(openViewAction);
  89. toolbar.add(messagePopupAction);
  90. }
  91. }

注意:

#1 makeActions() 是由平台来调用的，用来创建所有与菜单和工具栏想关联的 actions 。一个Action是一个拥有用户接口组件(菜单和工具栏如何显示)和功能组件(动作)的简单类。可以通过查看Javadoc 的 ActionFactory 和ContributionItemFactory来了解被支持的 Workbench actions列表。
#2 fillMenuBar() 是用actions来填充工作台的菜单栏. RCP Mail 包含了两个顶层菜单, "File" 和 "Help". 首先你要为每个顶层菜单创建一个 MenuManager，然后将菜单添加到菜单栏，将actions添加到菜单。
#3 fillCoolBar() 定义了Workbench的coolbar . 一个 coolbar 是 toolbars的集合, 而一个 toolbar 又是actions的集合. 在这个实例中只有一个 toolbar. 你先创建一个新的toolbar manager , 然后添加 toolbar 到 coolbar, 最好添加actions 到toolbar.

Note: 创建一些placeholders来容纳那些通过插件添加进来的附加菜单项是一个好办法. 在开始编码时，你应该使用那些标准的placeholder命名。通过使用预定义的groups，你可以像用插件plug-ins把菜单和工具栏项添加到 Eclipse IDE一样把它们添加进你的 RCP应用中.除了在Javadoc的IWorkbenchActionConstants以外没有其它任何的资料文档，即使在Javadoc中也没有任何指南。最好的参考就是Eclipse IDE 源代码本身。

Making it a product

RCP Mail 模板已经使用 org.eclipse.core.runtime.products扩展定义了一个product. 然而它不是一个 .products 文件，所以你必须创建一个包含扩展名的用户产品定义。选择 New > Product Configuration. 在列表中选择已存在的 product ID (org.eclipse.ui.tutorials.rcp.part3.product) 和已存在的application (org.eclipse.ui.tutorials.rcp.part3.application) . 然后输入产品名称 RCP Tutorial 3. 最好切换到配置标签页，添加插件。

Branding

RCP应用运行时，选择 Help > About RCP Tutorial 3. 你将会看到 Figure 3.

Figure 3. 标准的 About

下面让我们看看 RCP's branding标签项. 退出应用，切换到Product Configuration 编辑器的Branding标签项. 找到About对话框.然后 在Image项点击Browse按钮，在插件项目中选择 product_lg.gif . 该文件由RCP Mail template提供, 但你可以很容易的提供你自己的. 点击 OK 继续.

现在选中Text 部分，然后输入你想About对话框的显示内容.例如产品的名字，版本，技术支持和其它的版权许可信息.完成后保存配置信息，返回到 Overview 标签页, 点击 Synchronize, 再次加载. 当程序启动时打开 About 文本框，你将看到和 Figure 4一样.

Figure 4. With a branding you can add those little touches that make the application your own.

Tip: 确保在你的插件构建配置中包含了images和icons文件(在Plug-in Manifest 中的Build 标签，或者 build.properties 文件). 否则它们不会包含在插件的jar包中或在导出操作时不会拷贝它们。 模板中我们注意到了那些，但很容易在你自己的应用中忘记。

 

后记：花了一天的时间把这篇文章翻译完了，感觉上看得懂，但翻译起来有点拿不准，可能是我的英文太烂的原因吧。最近的项目需要用rcp技术来做，这是一篇入门的文章，以后我还会持续写一些自己的积累和体会。

分享到：
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    Rich Client Tutorial Part 3

    2. **设置项目基本信息**：在后续页面中输入项目名（例如`org.eclipse.ui.tutorials.rcp.part3`），指示创建一个Java项目，选择Eclipse的目标版本（至少3.1），并启用创建OSGi Bundle清单文件的选项。 3. **选择...

    Rich Client Tutorial Part 2

    富客户端平台（Rich Client Platform，简称RCP）应运而生，为构建功能强大且用户友好的Java应用程序提供了可能。本篇教程作为RCP系列教程的第二部分，将深入探讨如何利用RCP构建应用，并详细介绍一些关键配置类，...

    Rich Client Tutorial Part 1

    3. **集成工具支持**：Eclipse 3.1.2提供了更好的工具支持，使得创建RCP应用变得更加简单。 4. **性能优化**：通过优化，RCP能够提供接近原生应用的性能体验。 #### 构建RCP应用的步骤 构建一个RCP应用通常涉及...

    Apress.JavaFX.Script.Oct.2007

    The book "JavaFX™Script: Dynamic Java™ Scripting for Rich Internet/Client-Side Applications" is part of Apress’s firstPress series. This series is known for providing concise, focused content on ...

    GEF及GMF入门学习

    - `gef.tutorial.step.ui`包中的Editor继承自`org.eclipse.ui.part.EditorPart`。 - 实现图形显示逻辑, 包括图形的绘制、交互等。 #### 三、GEF的基本结构解析 - **模型(Model)**: 定义数据结构, 是整个应用的...

    GEF最好的学习文档，入门必读（GEF-whole-upload.pdf）

    4. **选择Rich Client Application**：在项目属性中选择“Rich Client Application”选项，并选择“Yes”。 5. **选择Hello RCP模板**：从模板列表中选择“Hello RCP”，然后点击“Finish”。 #### 四、配置依赖...

    gef简单入门

    建立RCP（Rich Client Platform）项目是使用GEF进行图形编辑器开发的第一步。在Eclipse环境中，选择`File > New > Other...`，然后在弹出的对话框中找到并选择`Plug-in Project`。命名项目为`gef.tutorial.stepz`，...

    GEF中文教程

    - **RCP (Rich Client Platform)**：基于Eclipse的富客户端平台，可用来构建桌面应用程序。 - **创建RCP项目**：在Eclipse中通过选择“File” -> “New” -> “Plug-in Project”来创建一个新的RCP项目。 - **项目...

    GEF快速入门教程和EMF教程

    - 在“Rich Client Application”选项中选择“Yes”。 2. **设置依赖**: - 为项目添加`org.eclipse.gef (3.1.0)`依赖。这可以通过编辑`plugin.xml`文件并在“dependencies”部分添加相应的条目完成。 - 添加依赖...

    GEF-whole-upload

    - 在“Rich Client Application”选项中选择“Yes”。 - 选择模板为“HelloRCP”，点击“Finish”。 #### 创建GEF Editor 1. **设置依赖关系** - 打开`plugin.xml`文件，在“Dependencies”标签页中添加`org....

    GEF中文教程（以hello world为例）

    **选择RCP选项**：在“Rich Client Application”中选择“Yes”。 4. **选择初始模板**：选择“Hello RCP”，并点击“Finish”完成创建。 - **依赖项配置**： - **添加GEF依赖**：打开`plugin.xml`文件，在...

    GEF开发指南---插件开发

    - **RCP项目建立**：RCP（Rich Client Platform）项目是基于Eclipse的客户端应用程序。文档提到通过选择“Plug-in Project”并设置项目名为`gef.tutorial.stepz`来创建一个RCP项目。 - **显示RCP中的Editor**：在RCP...

    Professional Ajax

    Professional Ajax 2nd Edition provides a developer-level tutorial of Ajax techniques, patterns, and use cases. The book begins by exploring the roots of Ajax, covering how the evolution of the web and...

    python3.6.5参考手册 chm

    xmlrpc.client zipfile zlib Optimizations Build and C API Changes Other Improvements Deprecated New Keywords Deprecated Python behavior Deprecated Python modules, functions and methods asynchat...

    C & C++ Win32 API Programming

    3. **Tools and Compilers**: Familiarize yourself with tools like Visual Studio, which offers a rich development environment tailored for Windows development. #### The Simplest Win32 Program The ...

Magicbox
Global site tag (gtag.js) - Google Analytics