First Steps in RCP. Jan Blankenhorn, WeigleWilczek GmbH, Stuttgart, Germany. February 19th, 2009

Transcription

1 First Steps in RCP Jan Blankenhorn, WeigleWilczek GmbH, Stuttgart, Germany February 19th, 2009

2 Agenda» About us» RCP Architecture and Bundles» Extension Points and Views» Bundle Dependencies 2

3 Jan Blankenhorn» Software engineer at WeigleWilczek GmbH» 3 years of Java development:» 1 year of Eclipse RCP development» Involved in 3 ongoing RCP projects» JEE and JSF on JBoss AS» 3 years of Eclipse IDE» blankenhorn@weiglewilczek.com 3

4 About the Eclipse Training Alliance» Founded December 2005 by WeigleWilczek and Innoopract» WeigleWilczek now drives the initiative» Offerings:» International one-stop delivery of high quality Eclipse training classes» Certificates» Coaching and consulting We share expertise» 4

5 Contact Europe Please contact us for details: Eclipse Training Alliance c/o Weigle Wilczek GmbH Heiko Seeberger Martinstrasse D Esslingen Phone Fax

6 Agenda» About us» RCP Architecture and Bundles» Extension Points and Views» Bundle Dependencies 6

7 Why Eclipse RCP?» Very powerful platform for rich client applications» Available for all major operating systems» All sources provided» Large and active community» Commercial-friendly open source license: EPL And: Eclipse RCP is fun! 7

8 High-level RCP Architecture JB11 8

9 Slide 8 JB11 Notizen Jan Blankenhorn, 2/17/2009

10 Modular Architecture» Eclipse is not a monolithic system but an open platform» Eclipse is based on an modular and extensible architecture:» Minimal runtime» Applications are composed of modules called bundles or plug-ins» Plug-ins can be added, updated or removed Plug-in Plug-in Plug-in Plug-in Runtime 9

11 What is a Bundle/Plug-in?» Bundles are components:» Execution in a runtime container Eclipse Equinox» Well defined deployment format JAR file» Declared public API exported packages» Declared dependencies imported packages or required bundles» Well defined life cycle installed, resolved, active, uninstalled» Plug-ins may offer extension points» RCP applications are built from plug-ins Ext. point Plug-in Plug-in Plug-in Plug-in 10

12 How does a Plug-in look like?» Plug-ins are common JAR archives,»... contain a bundle manifest (MANIFEST.MF) and»... may contain a plug-in manifest (plugin.xml). 11

13 The Bundle Manifest (MANIFEST.MF)» Located at : META-INF/MANIFEST.MF» Text file with property-like syntax: Manifest headers with values» Declares metadata, public API, dependencies etc. Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: Contacts Core Bundle-SymbolicName: net.eclipsetraining.contacts.core Bundle-Version: Bundle-Vendor: WeigleWilczek Bundle-RequiredExecutionEnvironment: J2SE-1.5 Export-Package: net.eclipsetraining.contacts.core;version="1.0.0" 12

14 The Plug-in Development Environment (PDE)» PDE supports plug-in development:» Plug-in projects: Build path derived from MANIFEST.MF» Manifest editor for MANIFEST.MF and plugin.xml manifest files» Run/launch configurations for Eclipse applications and OSGi»... 13

15 The Workbench Window Perspective Source: Eclipse Help, Eclipse Public License Version

16 How can the Workbench be configured?» The workbench is created internally by RCP» You can advise this process» Workbench advisor» Workbench window advisor» Action bar advisor: Since 3.3 better use commands! 15

17 The Workbench Advisor...»... defines the default perspective for the public String getinitialwindowperspectiveid() {...»... activates the save-and-restore behavior of the workbench:» Window size, position etc. are restored on reopening» The data is persisted between sessions in the applcation s workspace data dir (see in run configuration, Main public void initialize(final IWorkbenchConfigurer configurer) { super.initialize(configurer); configurer.setsaveandrestore(true); } 16

18 The Workbench Window Advisor...»... configures the workbench window:» Window size» Window title» Visibility of menu bar, toolbars, status bar public void prewindowopen() { getwindowconfigurer().setinitialsize(new Point(400, 300)); getwindowconfigurer().setshowcoolbar(false); getwindowconfigurer().setshowstatusline(false); getwindowconfigurer().settitle("contacts"); } 17

19 Task: Create a Hello world! RCP application Demonstration

20 Task: Create a Hello world! RCP application» Step 1:» Use the New wizard to create a new Plug-in Project» Enter net.eclipsetraining.webinar.core as project name» Uncheck Generate an activator...» Select Yes for Would you like... rich client application?» Select the Hello RCP template» Enter Hello world! as the Application window title and click Finish» Step 2:» The manifest editor will open: Click the icon or the link Launch an Eclipse application 19

21 Agenda» About us» RCP Architecture and Bundles» Extension Points and Views» Bundle Dependencies 20

22 What is a Perspective?» A Perspective arranges workbench parts (Views and Editors)» Perspectives are typically used for "bundling" of role-specific functionalities, e.g. end user mode, administration mode etc.» Perspectives can optionally be switched by the user» There has to be a default perspective! 21

23 View Features (1)» Can be moved and docked anywhere on the workbench window» Can be stacked one over another:» Can have their own menu and toolbars: 22

24 View Features (2)» Can be detached from the workbench window: 23

25 What are Extension Points and Extensions?» Extension points let a plug-in be extended by new functionality, e.g.:» Menus (UI)» File types (editors)» Products, own business domain classes etc.» New functionality is contributed by extensions» Plug-ins declaring extension points are called enablers, these declaring extensions are called extenders Ext. point Extender Enabler 24

26 Background: The Extension Registry» Extension points and extensions are declared in the plug-in manifest (plugin.xml)» The extension registry scans the declarations on startup» Extensions are matched to extension points» Only declarative information is used, no classes are loaded so far» Sometime the enabler queries the extension registry for extensions:» The extenders' declarative information is used, e.g. menu labels» If needed, the extender(s) is/are asked for an executable extension (Java class) and program flow is delegated to the extender(s) Ext. point Extender use call Enabler 25

27 Contributing Extensions (1)» Extensions are declared in the plug-in manifest (plugin.xml):» The extension-element is used» Extension points are referenced by ID and namespace» Extensions have to stick to the given extension point schema <extension id="application" point="org.eclipse.core.runtime.applications"> <application> <run class="net...application.internal.application.application"> </run> </application> </extension> 26

28 Contributing Extensions (2)» The PDE tooling for plugin.xml is providing an Extensions tab for displaying and editing the extensions: 27

29 Views are contributed...»... through the extension point org.eclipse.ui.views:» The class attribute specifies an IViewPart-implementation» The id attribute is later used to reference the view» The name attribute defines the label shown in the workbench <extension point="org.eclipse.ui.views"> <view class="net...listview.internal.listview" id="net...listview.views.listview" name="contact List">... > </view> </extension> 28

30 View Implementations» Views have to implement IViewPart» Tip: Extend the base class ViewPart! public class ListView extends ViewPart public void createpartcontrol(final Composite parent) {... public void setfocus() {... } 29

31 Task: Add a View to the Application Demonstration

32 Task: Add a View to the Application (1)» Step 1: Create a new plug-in project» Project name: net.eclipsetraining.webinar.ui.view» Do generate an Activator (check): net.eclipsetraining. webinar.ui.view.internal.activator» Do contribute to the UI (check)» Do NOT create a rich client application or use any templates» Step 2: Contribute a view for a Person» ID: net.eclipsetraining.webinar.ui.view. views.personview» Extension Point org.eclipse.ui.views» Name: Person View» Class: net.eclipsetraining.webinar.ui.view. internal.personview» Extend ViewPart with empty method skeletons or trace output 31

33 Task: Add a View to the Application (2)» Step 3: Contribute a perspective extension» Create an Extension Point for org.eclipse.ui.perspectiveextensions» Add the Person View view to the default perspective» org.eclipse.ui.editorss» Step 4: Run the updated application» Take care to update the run configuration(s) correctly!» Try some of the view features, e.g. docking and detaching 32

34 Agenda» About us» RCP Architecture and Bundles» Extension Points and Views» Bundle Dependencies 33

35 Declaring the public API» Classes and resources are not visible from other bundles by default» A bundle has to declare its public API explicitly:» The manifest header Export-Package is used» All listed packages are made visible to other bundles» Packages are separated by comma» Package version should be specified! Export-Package: net.eclipsetraining.contacts.core;version="1.0.0" 34

36 Declaring Bundle Dependencies (1)» A bundle has to declare its dependencies explicitly» One way is to declare dependent packages:» The manifest header Import-Package is used» All listed packages are made available for the bundle» Packages are separated by comma» A package version or version range may be used» A package can be required optionally Import-Package: net.eclipsetraining.contacts.core;version="[1.0.0,2.0.0)" 35

37 Declaring Bundle Dependencies (2)» Another way is to declare required bundles:» The manifest header Require-Bundle is used» All exported packages from the listed bundles are made available» Bundles are separated by comma» A bundle version or version range can be used» A bundle can be required optionally Require-Bundle: org.eclipse.core.runtime;bundle-version="3.4.0", org.eclipse.ui;bundle-version="3.4.0" 36

38 Task: Display Data from Core Plugin in UI Plugin Demonstration

39 Task: Display Data from Core Plugin in UI Plugin» Step 1: Create an Entity Class in.core Plugin» Create the package: net.eclipsetraining.webinar.core.data» Create an interface Person» Add setters and getters for name and firstname» Create the package: net.eclipsetraining.webinar.core.data.internal» Create a class PersonImpl» Add the properties name and firstname» Step 2: Create a Dummy Person Factory» Create a class DummyPersonFactory» Add the static Method getperson()» Return a Person 38

40 Task: Display Data from Core Plugin in UI Plugin» Step 3: Export API» Export-Package net.eclipsetraining.webinar.core.data» Notice that..internal Package is not exported» Step 4: Add dependencies:» Require-Bundle is already there for org.eclipse.ui and org.eclipse.core.runtime: Use version 3.4.0» Import-Package for net.eclipsetraining.webinar.core.data» Step 5: Display Person from Core in the Person View» Add 2 Labels in createpartcontrol()» Set Text of the Labels to Person.getName() and Person.getFirstName() 39

41 The End Thank You!! We will answer your Questions now! 40